Try SpotterFetches details about one or multiple SecurityList resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about one or multiple SecurityList resources in Oracle Cloud Infrastructure
Lists the security lists in the specified VCN and compartment. If the VCN ID is not provided, then the list includes the security lists from all VCNs in the specified compartment.
If I(security_list_id) is specified, the details of a single SecurityList will be returned.
- name: Get a specific security_list
oci_network_security_list_facts:
# required
security_list_id: "ocid1.securitylist.oc1..xxxxxxEXAMPLExxxxxx"
- name: List security_lists
oci_network_security_list_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
sort_by: TIMECREATED
sort_order: ASC
lifecycle_state: PROVISIONING
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
vcn_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the VCN.
type: str
sort_by:
choices:
- TIMECREATED
- DISPLAYNAME
description:
- The field to sort by. You can provide one sort order (`sortOrder`). Default order
for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME
sort order is case sensitive.
- '**Note:** In general, some "List" operations (for example, `ListInstances`) let
you optionally filter by availability domain if the scope of the resource type is
within a single availability domain. If you call one of these "List" operations
without specifying an availability domain, the resources are grouped by availability
domain, then sorted.'
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
sort_order:
choices:
- ASC
- DESC
description:
- The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME
sort order is case sensitive.
type: str
cert_bundle:
description:
- 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.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
display_name:
aliases:
- name
description:
- A filter to return only resources that match the given display name exactly.
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment.
- Required to list multiple security_lists.
type: str
lifecycle_state:
choices:
- PROVISIONING
- AVAILABLE
- TERMINATING
- TERMINATED
description:
- A filter to only return resources that match the given lifecycle state. The state
value is case-insensitive.
type: str
security_list_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the security list.
- Required to get a specific security_list.
type: str
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
realm_specific_endpoint_template_enabled:
description:
- Enable/Disable realm specific endpoint template for service client. By Default,
realm specific endpoint template is disabled. If not set, then the value of the
OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
type: bool
security_lists:
contains:
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment containing the security list.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable. Avoid
entering confidential information.
returned: on success
sample: display_name_example
type: str
egress_security_rules:
contains:
description:
description:
- An optional description of your choice for the rule.
returned: on success
sample: description_example
type: str
destination:
description:
- 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 L(IPv6 Addresses,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).'
- ' * The `cidrBlock` value for a L(Service,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/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`.'
returned: on success
sample: destination_example
type: str
destination_type:
description:
- 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 L(Service,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Service/)
(the rule is for traffic destined for a particular `Service` through a
service gateway).'
returned: on success
sample: CIDR_BLOCK
type: str
icmp_options:
contains:
code:
description:
- The ICMP code (optional).
returned: on success
sample: 56
type: int
type:
description:
- The ICMP type.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
is_stateless:
description:
- 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.
returned: on success
sample: true
type: bool
protocol:
description:
- The transport protocol. Specify either `all` or an IPv4 protocol number
as defined in L(Protocol Numbers,http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and
ICMPv6 ("58").
returned: on success
sample: protocol_example
type: str
tcp_options:
contains:
destination_port_range:
contains:
max:
description:
- 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.
returned: on success
sample: 56
type: int
min:
description:
- The minimum port number, which must not be greater than the maximum
port number.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
source_port_range:
contains:
max:
description:
- 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.
returned: on success
sample: 56
type: int
min:
description:
- The minimum port number, which must not be greater than the maximum
port number.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
udp_options:
contains:
destination_port_range:
contains:
max:
description:
- 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.
returned: on success
sample: 56
type: int
min:
description:
- The minimum port number, which must not be greater than the maximum
port number.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
source_port_range:
contains:
max:
description:
- 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.
returned: on success
sample: 56
type: int
min:
description:
- The minimum port number, which must not be greater than the maximum
port number.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
description:
- Rules for allowing egress IP packets.
returned: on success
type: complex
freeform_tags:
description:
- 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 L(Resource
Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
id:
description:
- The security list's Oracle Cloud ID (L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
ingress_security_rules:
contains:
description:
description:
- An optional description of your choice for the rule.
returned: on success
sample: description_example
type: str
icmp_options:
contains:
code:
description:
- The ICMP code (optional).
returned: on success
sample: 56
type: int
type:
description:
- The ICMP type.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
is_stateless:
description:
- 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.
returned: on success
sample: true
type: bool
protocol:
description:
- The transport protocol. Specify either `all` or an IPv4 protocol number
as defined in L(Protocol Numbers,http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml).
Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and
ICMPv6 ("58").
returned: on success
sample: protocol_example
type: str
source:
description:
- 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 L(IPv6 Addresses,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).'
- ' * The `cidrBlock` value for a L(Service,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/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`.'
returned: on success
sample: source_example
type: str
source_type:
description:
- 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 L(Service,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Service/)
(the rule is for traffic coming from a particular `Service` through a
service gateway).'
returned: on success
sample: CIDR_BLOCK
type: str
tcp_options:
contains:
destination_port_range:
contains:
max:
description:
- 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.
returned: on success
sample: 56
type: int
min:
description:
- The minimum port number, which must not be greater than the maximum
port number.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
source_port_range:
contains:
max:
description:
- 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.
returned: on success
sample: 56
type: int
min:
description:
- The minimum port number, which must not be greater than the maximum
port number.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
udp_options:
contains:
destination_port_range:
contains:
max:
description:
- 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.
returned: on success
sample: 56
type: int
min:
description:
- The minimum port number, which must not be greater than the maximum
port number.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
source_port_range:
contains:
max:
description:
- 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.
returned: on success
sample: 56
type: int
min:
description:
- The minimum port number, which must not be greater than the maximum
port number.
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
description:
- Rules for allowing ingress IP packets.
returned: on success
type: complex
lifecycle_state:
description:
- The security list's current state.
returned: on success
sample: PROVISIONING
type: str
time_created:
description:
- The date and time the security list was created, in the format defined by
L(RFC3339,https://tools.ietf.org/html/rfc3339).
- 'Example: `2016-08-25T21:10:29.600Z`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
vcn_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the VCN the security list belongs to.
returned: on success
sample: ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- List of SecurityList resources
returned: on success
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
type: complex