oracle / oracle.oci / 4.2.0 / module / oci_identity_network_sources Manage a NetworkSources resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_identity_network_sources (4.2.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.2.0
collections: - name: oracle.oci version: 4.2.0
This module allows the user to create, update and delete a NetworkSources resource in Oracle Cloud Infrastructure
For I(state=present), creates a new network source in your tenancy.
You must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies) reside within the tenancy itself, unlike cloud resources such as compute instances, which typically reside within compartments inside the tenancy. For information about OCIDs, see L(Resource Identifiers,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
You must also specify a *name* for the network source, which must be unique across all network sources in your tenancy, and cannot be changed. You can use this name or the OCID when writing policies that apply to the network source. For more information about policies, see L(How Policies Work,https://docs.cloud.oracle.com/Content/Identity/policieshow/how-policies-work.htm).
You must also specify a *description* for the network source (although it can be an empty string). It does not have to be unique, and you can change it anytime with L(UpdateNetworkSource,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/identity/20160918/NetworkSource/UpdateNetworkSource).
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.
After your network resource is created, you can use it in policy to restrict access to only requests made from an allowed IP address specified in your network source. For more information, see L(Managing Network Sources,https://docs.cloud.oracle.com/Content/Identity/Tasks/managingnetworksources.htm).
- name: Create network_sources oci_identity_network_sources: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" name: name_example description: description_example # optional public_source_list: [ "public_source_list_example" ] virtual_source_list: - # optional vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx" ip_ranges: [ "ip_ranges_example" ] services: [ "services_example" ] freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update network_sources oci_identity_network_sources: # required network_source_id: "ocid1.networksource.oc1..xxxxxxEXAMPLExxxxxx" # optional description: description_example public_source_list: [ "public_source_list_example" ] virtual_source_list: - # optional vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx" ip_ranges: [ "ip_ranges_example" ] services: [ "services_example" ] freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Update network_sources using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_identity_network_sources: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" name: name_example # optional description: description_example public_source_list: [ "public_source_list_example" ] virtual_source_list: - # optional vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx" ip_ranges: [ "ip_ranges_example" ] services: [ "services_example" ] freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}}
- name: Delete network_sources oci_identity_network_sources: # required network_source_id: "ocid1.networksource.oc1..xxxxxxEXAMPLExxxxxx" state: absent
- name: Delete network_sources using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_identity_network_sources: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" name: name_example state: absent
name: description: - The name you assign to the network source during creation. The name must be unique across all groups in the tenancy and cannot be changed. - Required for create using I(state=present). - Required for update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. type: str wait: default: true description: Whether to wait for create or delete operation to complete. type: bool state: choices: - present - absent default: present description: - The state of the NetworkSources. - Use I(state=present) to create or update a NetworkSources. - Use I(state=absent) to delete a NetworkSources. required: false type: str key_by: description: 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. elements: str type: list 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 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 services: description: - -- The services attribute has no effect and is reserved for use by Oracle. -- - This parameter is updatable. elements: str type: list auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal 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 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 description: description: - The description you assign to the network source during creation. Does not have to be unique, and it's changeable. - Required for create using I(state=present). - This parameter is updatable. 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 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/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`' - This parameter is updatable. type: dict force_create: default: false description: 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 I(key_by). type: bool wait_timeout: description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most of the services but some services might have a longer wait timeout. type: int 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/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`' - This parameter is updatable. type: dict compartment_id: description: - The OCID of the tenancy (root compartment) containing the network source object. - Required for create using I(state=present). - Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. 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 network_source_id: aliases: - id description: - The OCID of the network source. - Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. - Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. type: str public_source_list: description: - A list of allowed public IP addresses and CIDR ranges. - This parameter is updatable. elements: str type: list 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 virtual_source_list: description: - 'A list of allowed VCN OCID and IP range pairs. Example:`"vcnId": "ocid1.vcn.oc1.iad.aaaaaaaaexampleuniqueID", "ipRanges": [ "129.213.39.0/24" ]`' - This parameter is updatable. elements: dict suboptions: ip_ranges: description: - '' elements: str type: list vcn_id: description: - '' type: str type: list 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
network_sources: contains: compartment_id: description: - The OCID of the tenancy containing the network source. The tenancy is the root compartment. 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/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`' returned: on success sample: Operations: CostCenter: US type: dict description: description: - The description you assign to the network source. Does not have to be unique, and it's changeable. returned: on success sample: description_example type: str 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/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict id: description: - The OCID of the network source. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str inactive_status: description: - The detailed status of INACTIVE lifecycleState. returned: on success sample: 56 type: int lifecycle_state: description: - The network source object's current state. After creating a network source, make sure its `lifecycleState` changes from CREATING to ACTIVE before using it. returned: on success sample: CREATING type: str name: description: - The name you assign to the network source during creation. The name must be unique across the tenancy and cannot be changed. returned: on success sample: name_example type: str public_source_list: description: - A list of allowed public IPs and CIDR ranges. returned: on success sample: [] type: list services: description: - -- The services attribute has no effect and is reserved for use by Oracle. -- returned: on success sample: [] type: list time_created: description: - Date and time the group was created, in the format defined by RFC3339. - 'Example: `2016-08-25T21:10:29.600Z`' returned: on success sample: '2013-10-20T19:20:30+01:00' type: str virtual_source_list: contains: ip_ranges: description: - '' returned: on success sample: [] type: list vcn_id: description: - '' returned: on success sample: ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx type: str description: - 'A list of allowed VCN OCID and IP range pairs. Example:`"vcnId": "ocid1.vcn.oc1.iad.aaaaaaaaexampleuniqueID", "ipRanges": [ "129.213.39.0/24" ]`' returned: on success type: complex description: - Details of the NetworkSources resource acted upon by the current operation returned: on success sample: compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx defined_tags: Operations: CostCenter: US description: description_example freeform_tags: Department: Finance id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx inactive_status: 56 lifecycle_state: CREATING name: name_example public_source_list: [] services: [] time_created: '2013-10-20T19:20:30+01:00' virtual_source_list: - ip_ranges: [] vcn_id: ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx type: complex