oracle.oci.oci_network_security_list – Manage a SecurityList resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_network_security_list.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a SecurityList resource in Oracle Cloud Infrastructure

  • For state=present, creates a new security list for the specified VCN. For more information about security lists, see Security Lists. For information on the number of rules you can have in a security list, see Service Limits.

  • For the purposes of access control, you must provide the OCID of the compartment where you want the security list to reside. Notice that the security list doesn’t have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you’re not sure which compartment to use, put the security list in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.

  • You may optionally specify a display name for the security list, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

  • This resource has the following action operations in the oracle.oci.oci_network_security_list_actions module: change_compartment.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The OCID of the compartment to contain the security list.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
delete_security_rules
boolean
    Choices:
  • no
  • yes
Default:
"false"
Delete security rules from existing security list which are present in the security rules provided by ingress_security_rules and/or egress_security_rules. If delete_security_rules=yes, security rules provided by ingress_security_rules and/or egress_security_rules would be deleted to existing security list, if they are part of existing security list. If they are not part of existing security list, they will be ignored. purge_security_rules and delete_security_rules are mutually exclusive.
This parameter is updatable.
display_name
string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
egress_security_rules
list / elements=dictionary
Rules for allowing egress IP packets.
Required for create using state=present.
This parameter is updatable.
description
string
An optional description of your choice for the rule.
destination
string / required
Conceptually, this is the range of IP addresses that a packet originating from the instance can go to.
Allowed values:
* IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` Note that IPv6 addressing is currently supported only in certain regions. See IPv6 Addresses.
* The `cidrBlock` value for a Service, if you're setting up a security list rule for traffic destined for a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`.
destination_type
string
    Choices:
  • CIDR_BLOCK
  • SERVICE_CIDR_BLOCK
Type of destination for the rule. The default is `CIDR_BLOCK`.
Allowed values:
* `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.
* `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a Service (the rule is for traffic destined for a particular `Service` through a service gateway).
icmp_options
dictionary
code
integer
The ICMP code (optional).
type
integer / required
The ICMP type.
is_stateless
boolean
    Choices:
  • no
  • yes
A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.
protocol
string / required
The transport protocol. Specify either `all` or an IPv4 protocol number as defined in Protocol Numbers. Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58").
tcp_options
dictionary
destination_port_range
dictionary
max
integer / required
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
min
integer / required
The minimum port number, which must not be greater than the maximum port number.
source_port_range
dictionary
max
integer / required
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
min
integer / required
The minimum port number, which must not be greater than the maximum port number.
udp_options
dictionary
destination_port_range
dictionary
max
integer / required
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
min
integer / required
The minimum port number, which must not be greater than the maximum port number.
source_port_range
dictionary
max
integer / required
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
min
integer / required
The minimum port number, which must not be greater than the maximum port number.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
This parameter is updatable.
ingress_security_rules
list / elements=dictionary
Rules for allowing ingress IP packets.
Required for create using state=present.
This parameter is updatable.
description
string
An optional description of your choice for the rule.
icmp_options
dictionary
code
integer
The ICMP code (optional).
type
integer / required
The ICMP type.
is_stateless
boolean
    Choices:
  • no
  • yes
A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if ingress traffic allows TCP destination port 80, there should be an egress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.
protocol
string / required
The transport protocol. Specify either `all` or an IPv4 protocol number as defined in Protocol Numbers. Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58").
source
string / required
Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.
Allowed values:
* IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`. IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.
* The `cidrBlock` value for a Service, if you're setting up a security list rule for traffic coming from a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`.
source_type
string
    Choices:
  • CIDR_BLOCK
  • SERVICE_CIDR_BLOCK
Type of source for the rule. The default is `CIDR_BLOCK`.
* `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation.
* `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a Service (the rule is for traffic coming from a particular `Service` through a service gateway).
tcp_options
dictionary
destination_port_range
dictionary
max
integer / required
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
min
integer / required
The minimum port number, which must not be greater than the maximum port number.
source_port_range
dictionary
max
integer / required
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
min
integer / required
The minimum port number, which must not be greater than the maximum port number.
udp_options
dictionary
destination_port_range
dictionary
max
integer / required
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
min
integer / required
The minimum port number, which must not be greater than the maximum port number.
source_port_range
dictionary
max
integer / required
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.
min
integer / required
The minimum port number, which must not be greater than the maximum port number.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
purge_security_rules
boolean
    Choices:
  • no
  • yes
Default:
"true"
Purge security rules from security list which are not present in the provided group security list. If purge_security_rules=no, provided security rules would be appended to existing security rules. purge_security_rules and delete_security_rules are mutually exclusive.
This parameter is updatable.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
security_list_id
string
The OCID of the security list.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
state
string
    Choices:
  • present ←
  • absent
The state of the SecurityList.
Use state=present to create or update a SecurityList.
Use state=absent to delete a SecurityList.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
vcn_id
string
The OCID of the VCN the security list belongs to.
Required for create using state=present.
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create security_list
  oci_network_security_list:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
    egress_security_rules:
    - # required
      destination: destination_example
      protocol: protocol_example

      # optional
      destination_type: CIDR_BLOCK
      icmp_options:
        # required
        type: 56

        # optional
        code: 56
      is_stateless: true
      tcp_options:
        # optional
        destination_port_range:
          # required
          max: 56
          min: 56
        source_port_range:
          # required
          max: 56
          min: 56
      udp_options:
        # optional
        destination_port_range:
          # required
          max: 56
          min: 56
        source_port_range:
          # required
          max: 56
          min: 56
      description: description_example
    ingress_security_rules:
    - # required
      protocol: protocol_example
      source: source_example

      # optional
      icmp_options:
        # required
        type: 56

        # optional
        code: 56
      is_stateless: true
      source_type: CIDR_BLOCK
      tcp_options:
        # optional
        destination_port_range:
          # required
          max: 56
          min: 56
        source_port_range:
          # required
          max: 56
          min: 56
      udp_options:
        # optional
        destination_port_range:
          # required
          max: 56
          min: 56
        source_port_range:
          # required
          max: 56
          min: 56
      description: description_example

    # optional
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}

- name: Update security_list
  oci_network_security_list:
    # required
    security_list_id: "ocid1.securitylist.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    purge_security_rules: false
    delete_security_rules: true
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    display_name: display_name_example
    egress_security_rules:
    - # required
      destination: destination_example
      protocol: protocol_example

      # optional
      destination_type: CIDR_BLOCK
      icmp_options:
        # required
        type: 56

        # optional
        code: 56
      is_stateless: true
      tcp_options:
        # optional
        destination_port_range:
          # required
          max: 56
          min: 56
        source_port_range:
          # required
          max: 56
          min: 56
      udp_options:
        # optional
        destination_port_range:
          # required
          max: 56
          min: 56
        source_port_range:
          # required
          max: 56
          min: 56
      description: description_example
    freeform_tags: {'Department': 'Finance'}
    ingress_security_rules:
    - # required
      protocol: protocol_example
      source: source_example

      # optional
      icmp_options:
        # required
        type: 56

        # optional
        code: 56
      is_stateless: true
      source_type: CIDR_BLOCK
      tcp_options:
        # optional
        destination_port_range:
          # required
          max: 56
          min: 56
        source_port_range:
          # required
          max: 56
          min: 56
      udp_options:
        # optional
        destination_port_range:
          # required
          max: 56
          min: 56
        source_port_range:
          # required
          max: 56
          min: 56
      description: description_example

- name: Update security_list using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_network_security_list:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    purge_security_rules: false
    delete_security_rules: true
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    egress_security_rules:
    - # required
      destination: destination_example
      protocol: protocol_example

      # optional
      destination_type: CIDR_BLOCK
      icmp_options:
        # required
        type: 56

        # optional
        code: 56
      is_stateless: true
      tcp_options:
        # optional
        destination_port_range:
          # required
          max: 56
          min: 56
        source_port_range:
          # required
          max: 56
          min: 56
      udp_options:
        # optional
        destination_port_range:
          # required
          max: 56
          min: 56
        source_port_range:
          # required
          max: 56
          min: 56
      description: description_example
    freeform_tags: {'Department': 'Finance'}
    ingress_security_rules:
    - # required
      protocol: protocol_example
      source: source_example

      # optional
      icmp_options:
        # required
        type: 56

        # optional
        code: 56
      is_stateless: true
      source_type: CIDR_BLOCK
      tcp_options:
        # optional
        destination_port_range:
          # required
          max: 56
          min: 56
        source_port_range:
          # required
          max: 56
          min: 56
      udp_options:
        # optional
        destination_port_range:
          # required
          max: 56
          min: 56
        source_port_range:
          # required
          max: 56
          min: 56
      description: description_example

- name: Delete security_list
  oci_network_security_list:
    # required
    security_list_id: "ocid1.securitylist.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete security_list using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_network_security_list:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
security_list
complex
on success
Details of the SecurityList resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'egress_security_rules': [{'description': 'description_example', 'destination': 'destination_example', 'destination_type': 'CIDR_BLOCK', 'icmp_options': {'code': 56, 'type': 56}, 'is_stateless': True, 'protocol': 'protocol_example', 'tcp_options': {'destination_port_range': {'max': 56, 'min': 56}, 'source_port_range': {'max': 56, 'min': 56}}, 'udp_options': {'destination_port_range': {'max': 56, 'min': 56}, 'source_port_range': {'max': 56, 'min': 56}}}], 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ingress_security_rules': [{'description': 'description_example', 'icmp_options': {'code': 56, 'type': 56}, 'is_stateless': True, 'protocol': 'protocol_example', 'source': 'source_example', 'source_type': 'CIDR_BLOCK', 'tcp_options': {'destination_port_range': {'max': 56, 'min': 56}, 'source_port_range': {'max': 56, 'min': 56}}, 'udp_options': {'destination_port_range': {'max': 56, 'min': 56}, 'source_port_range': {'max': 56, 'min': 56}}}], 'lifecycle_state': 'PROVISIONING', 'time_created': '2013-10-20T19:20:30+01:00', 'vcn_id': 'ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx'}
 
compartment_id
string
on success
The OCID of the compartment containing the security list.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
egress_security_rules
complex
on success
Rules for allowing egress IP packets.

   
description
string
on success
An optional description of your choice for the rule.

Sample:
description_example
   
destination
string
on success
Conceptually, this is the range of IP addresses that a packet originating from the instance can go to.
Allowed values:
* IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` Note that IPv6 addressing is currently supported only in certain regions. See IPv6 Addresses.
* The `cidrBlock` value for a Service, if you're setting up a security list rule for traffic destined for a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`.

Sample:
destination_example
   
destination_type
string
on success
Type of destination for the rule. The default is `CIDR_BLOCK`.
Allowed values:
* `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.
* `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a Service (the rule is for traffic destined for a particular `Service` through a service gateway).

Sample:
CIDR_BLOCK
   
icmp_options
complex
on success

     
code
integer
on success
The ICMP code (optional).

Sample:
56
     
type
integer
on success
The ICMP type.

Sample:
56
   
is_stateless
boolean
on success
A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.

Sample:
True
   
protocol
string
on success
The transport protocol. Specify either `all` or an IPv4 protocol number as defined in Protocol Numbers. Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58").

Sample:
protocol_example
   
tcp_options
complex
on success

     
destination_port_range
complex
on success

       
max
integer
on success
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Sample:
56
       
min
integer
on success
The minimum port number, which must not be greater than the maximum port number.

Sample:
56
     
source_port_range
complex
on success

       
max
integer
on success
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Sample:
56
       
min
integer
on success
The minimum port number, which must not be greater than the maximum port number.

Sample:
56
   
udp_options
complex
on success

     
destination_port_range
complex
on success

       
max
integer
on success
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Sample:
56
       
min
integer
on success
The minimum port number, which must not be greater than the maximum port number.

Sample:
56
     
source_port_range
complex
on success

       
max
integer
on success
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Sample:
56
       
min
integer
on success
The minimum port number, which must not be greater than the maximum port number.

Sample:
56
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The security list's Oracle Cloud ID (OCID).

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
ingress_security_rules
complex
on success
Rules for allowing ingress IP packets.

   
description
string
on success
An optional description of your choice for the rule.

Sample:
description_example
   
icmp_options
complex
on success

     
code
integer
on success
The ICMP code (optional).

Sample:
56
     
type
integer
on success
The ICMP type.

Sample:
56
   
is_stateless
boolean
on success
A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if ingress traffic allows TCP destination port 80, there should be an egress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.

Sample:
True
   
protocol
string
on success
The transport protocol. Specify either `all` or an IPv4 protocol number as defined in Protocol Numbers. Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58").

Sample:
protocol_example
   
source
string
on success
Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.
Allowed values:
* IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`. IPv6 addressing is supported for all commercial and government regions. See IPv6 Addresses.
* The `cidrBlock` value for a Service, if you're setting up a security list rule for traffic coming from a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`.

Sample:
source_example
   
source_type
string
on success
Type of source for the rule. The default is `CIDR_BLOCK`.
* `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation.
* `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a Service (the rule is for traffic coming from a particular `Service` through a service gateway).

Sample:
CIDR_BLOCK
   
tcp_options
complex
on success

     
destination_port_range
complex
on success

       
max
integer
on success
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Sample:
56
       
min
integer
on success
The minimum port number, which must not be greater than the maximum port number.

Sample:
56
     
source_port_range
complex
on success

       
max
integer
on success
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Sample:
56
       
min
integer
on success
The minimum port number, which must not be greater than the maximum port number.

Sample:
56
   
udp_options
complex
on success

     
destination_port_range
complex
on success

       
max
integer
on success
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Sample:
56
       
min
integer
on success
The minimum port number, which must not be greater than the maximum port number.

Sample:
56
     
source_port_range
complex
on success

       
max
integer
on success
The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.

Sample:
56
       
min
integer
on success
The minimum port number, which must not be greater than the maximum port number.

Sample:
56
 
lifecycle_state
string
on success
The security list's current state.

Sample:
PROVISIONING
 
time_created
string
on success
The date and time the security list was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
vcn_id
string
on success
The OCID of the VCN the security list belongs to.

Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx


Authors

  • Oracle (@oracle)