Skip to content
This repository has been archived by the owner on May 1, 2021. It is now read-only.

Latest commit

 

History

History
415 lines (366 loc) · 29.6 KB

oci_security_list_facts_module.rst

File metadata and controls

415 lines (366 loc) · 29.6 KB
Raw
source

cloud/oracle/oci_security_list_facts.py

orphan

oci_security_list_facts -- Fetches details of a specific Security List or a list of Security Lists in the specified VCN and compartment

2.5

Synopsis

  • Fetches details of a specific Security List or a list of Security Lists in the specified VCN and compartment.oc

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_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
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.
compartment_id
-
Identifier of the compartment details about whose Security List must be retrieved
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.
display_name
string
Use display_name along with the other options to return only resources that match the given display name exactly.
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
-
Identifier of the Security List. Required if the details of a specific Security List details needs to be fetched. Mutually exclusive with compartment_id and vcn_id.

aliases: id
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
-
Identifier of the Virtual Cloud Network to which the Security List is attached.

Notes

Examples

# Note: These examples do not set authentication details.
# Get information about all Security List
- name: Get information about all security list within a vcn and compartment
  oci_security_list_facts:
    compartment_id: 'ocid.compartment..xxxxxEXAMPLExxxxx'
    vcn_id: 'ocid.vcn..xxxxxEXAMPLExxxxx'

# Get information about a specific Security List
- name: Get information about security list by id
  oci_security_list_facts:
    id: 'ocid1.securitylist.xxxxxEXAMPLExxxxx'

Return Values

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

Key Returned Description
security_lists
complex
 success
Attributes of the fetched Security List(s).

Sample:
[{'freeform_tags': {'region': 'east'}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'id': 'ocid1.securitylist.oc1.phx.xxxxxEXAMPLExxxxx', 'egress_security_rules': [{'protocol': 'all', 'icmp_options': None, 'destination_type': 'CIDR_BLOCK', 'is_stateless': None, 'tcp_options': None, 'destination': '0.0.0.0/0', 'udp_options': None}], 'vcn_id': 'ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx', 'defined_tags': {'features': {'capacity': 'medium'}}, 'display_name': 'ansible_security_list_one', 'lifecycle_state': 'AVAILABLE', 'ingress_security_rules': [{'source': '0.0.0.0/0', 'protocol': '6', 'icmp_options': None, 'source_type': 'CIDR_BLOCK', 'is_stateless': False, 'tcp_options': {'destination_port_range': {'min': 22, 'max': 22}, 'source_port_range': None}, 'udp_options': None}, {'source': '0.0.0.0/0', 'protocol': '1', 'icmp_options': {'code': 4, 'type': 3}, 'source_type': 'CIDR_BLOCK', 'is_stateless': False, 'tcp_options': None, 'udp_options': None}, {'source': 'oci-iad-objectstorage', 'protocol': '1', 'icmp_options': {'code': None, 'type': 3}, 'source_type': 'SERVICE_CIDR_BLOCK', 'is_stateless': False, 'tcp_options': None, 'udp_options': None}], 'time_created': '2017-11-24T05:33:44.779000+00:00'}, {'freeform_tags': {'region': 'west'}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'id': 'ocid1.securitylist.oc1.phx.xxxxxEXAMPLExxxxx', 'egress_security_rules': [{'protocol': 'all', 'icmp_options': None, 'destination_type': 'CIDR_BLOCK', 'is_stateless': True, 'tcp_options': None, 'destination': '10.0.0.0/8', 'udp_options': None}], 'vcn_id': 'ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx', 'defined_tags': {'features': {'capacity': 'large'}}, 'display_name': 'ansible_security_list_two', 'lifecycle_state': 'AVAILABLE', 'ingress_security_rules': [{'source': '0.0.0.0/0', 'protocol': '6', 'icmp_options': None, 'source_type': 'CIDR_BLOCK', 'is_stateless': False, 'tcp_options': {'destination_port_range': {'min': 50, 'max': 45}, 'source_port_range': None}, 'udp_options': None}, {'source': '0.0.0.0/0', 'protocol': '1', 'icmp_options': {'code': 4, 'type': 3}, 'source_type': 'CIDR_BLOCK', 'is_stateless': False, 'tcp_options': None, 'udp_options': None}], 'time_created': '2017-11-24T05:33:44.779000+00:00'}]
  compartment_id
string
 always
The identifier of the compartment containing the Security List

Sample:
ocid1.compartment.oc1.xzvf..oifds
  display_name
string
 always
Name assigned to the Security List during creation

Sample:
ansible_security_list
  egress_security_rules
list
 always
Rules for allowing egress IP packets

Sample:
[{'is-stateless': None, 'protocol': 'all', 'icmp-options': None, 'destination': '0.0.0.0/0', 'udp-options': None, 'tcp-options': None}]
  id
string
 always
Identifier of the Security List

Sample:
ocid1.securitylist.oc1.axdf
  ingress_security_rules
list
 always
Rules for allowing ingress IP packets

Sample:
[{'is-stateless': None, 'source': '0.0.0.0/0', 'protocol': '6', 'icmp-options': None, 'udp-options': None, 'tcp-options': {'destination-port-range': {'min': 22, 'max': 22}, 'source-port-range': None}}]
  lifecycle_state
string
 always
The current state of the Security List

Sample:
AVAILABLE
  time_created
datetime
 always
Date and time when the Security List was created, in the format defined by RFC3339

Sample:
2016-08-25 21:10:29.600000+00:00
  vcn_id
string
 always
Identifier of the Virtual Cloud Network to which the Security List is attached.

Sample:
ocid1.vcn..ixcd


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community <modules_support>. [community]

Authors

  • Debayan Gupta(@debayan_gupta)

Hint

If you notice any issues in this documentation you can edit this document to improve it.