oracle.oci.oci_network_subnet_actions – Perform actions on a Subnet resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_subnet_actions
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on a Subnet resource in Oracle Cloud Infrastructure
For action=add_ipv6_subnet_cidr, add an IPv6 prefix to a subnet.
For action=change_compartment, moves a subnet into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
For action=remove_ipv6_subnet_cidr, remove an IPv6 prefix from a subnet. At least one IPv6 CIDR should remain.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
action
string
/ required
|
|
The action to perform on the Subnet.
|
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
|
|
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
|
|
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 move the subnet to.
Required for action=change_compartment.
|
|
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 . |
|
ipv6_cidr_block
string
|
This field is not required and should only be specified when adding an IPv6 prefix to a subnet's IPv6 address space. SeeL(IPv6 Addresses,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
Example: `2001:0db8:0123::/64`
Required for action=add_ipv6_subnet_cidr, action=remove_ipv6_subnet_cidr.
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
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.
|
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. |
|
subnet_id
string
/ required
|
The OCID of the subnet.
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 |
|
wait
boolean
|
|
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.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Perform action add_ipv6_subnet_cidr on subnet
oci_network_subnet_actions:
# required
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
ipv6_cidr_block: ipv6_cidr_block_example
action: add_ipv6_subnet_cidr
- name: Perform action change_compartment on subnet
oci_network_subnet_actions:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
action: change_compartment
- name: Perform action remove_ipv6_subnet_cidr on subnet
oci_network_subnet_actions:
# required
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
ipv6_cidr_block: ipv6_cidr_block_example
action: remove_ipv6_subnet_cidr
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
subnet
complex
|
on success |
Details of the Subnet resource acted upon by the current operation
Sample:
{'availability_domain': 'Uocm:PHX-AD-1', 'cidr_block': 'cidr_block_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'dhcp_options_id': 'ocid1.dhcpoptions.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example', 'dns_label': 'dns_label_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ipv6_cidr_block': 'ipv6_cidr_block_example', 'ipv6_cidr_blocks': [], 'ipv6_virtual_router_ip': 'ipv6_virtual_router_ip_example', 'lifecycle_state': 'PROVISIONING', 'prohibit_internet_ingress': True, 'prohibit_public_ip_on_vnic': True, 'route_table_id': 'ocid1.routetable.oc1..xxxxxxEXAMPLExxxxxx', 'security_list_ids': [], 'subnet_domain_name': 'subnet_domain_name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'vcn_id': 'ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx', 'virtual_router_ip': 'virtual_router_ip_example', 'virtual_router_mac': 'virtual_router_mac_example'}
|
|
availability_domain
string
|
on success |
The subnet's availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets.
Example: `Uocm:PHX-AD-1`
Sample:
Uocm:PHX-AD-1
|
|
cidr_block
string
|
on success |
The subnet's CIDR block.
Example: `10.0.1.0/24`
Sample:
cidr_block_example
|
|
compartment_id
string
|
on success |
The OCID of the compartment containing the subnet.
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'}}
|
|
dhcp_options_id
string
|
on success |
The OCID of the set of DHCP options that the subnet uses.
Sample:
ocid1.dhcpoptions.oc1..xxxxxxEXAMPLExxxxxx
|
|
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
|
|
dns_label
string
|
on success |
A DNS label for the subnet, used in conjunction with the VNIC's hostname and VCN's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed.
The absence of this parameter means the Internet and VCN Resolver will not resolve hostnames of instances in this subnet.
For more information, see DNS in Your Virtual Cloud Network.
Example: `subnet123`
Sample:
dns_label_example
|
|
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 subnet's Oracle ID (OCID).
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
ipv6_cidr_block
string
|
on success |
For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet's IP address space. The subnet size is always /64. See IPv6 Addresses.
Example: `2001:0db8:0123:1111::/64`
Sample:
ipv6_cidr_block_example
|
|
ipv6_cidr_blocks
list
/ elements=string
|
on success |
The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet.
|
|
ipv6_virtual_router_ip
string
|
on success |
For an IPv6-enabled subnet, this is the IPv6 address of the virtual router.
Example: `2001:0db8:0123:1111:89ab:cdef:1234:5678`
Sample:
ipv6_virtual_router_ip_example
|
|
lifecycle_state
string
|
on success |
The subnet's current state.
Sample:
PROVISIONING
|
|
prohibit_internet_ingress
boolean
|
on success |
Whether to disallow ingress internet traffic to VNICs within this subnet. Defaults to false.
For IPV4, `prohibitInternetIngress` behaves similarly to `prohibitPublicIpOnVnic`. If it is set to false, VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the `assignPublicIp` flag in CreateVnicDetails). If `prohibitInternetIngress` is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a privatesubnet).
For IPv6, if `prohibitInternetIngress` is set to `true`, internet access is not allowed for any IPv6s assigned to VNICs in the subnet. Otherwise, ingress internet traffic is allowed by default.
Example: `true`
Sample:
True
|
|
prohibit_public_ip_on_vnic
boolean
|
on success |
Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the `assignPublicIp` flag in CreateVnicDetails). If `prohibitPublicIpOnVnic` is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet).
Example: `true`
Sample:
True
|
|
route_table_id
string
|
on success |
The OCID of the route table that the subnet uses.
Sample:
ocid1.routetable.oc1..xxxxxxEXAMPLExxxxxx
|
|
security_list_ids
list
/ elements=string
|
on success |
The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated *with the subnet*, but the rules are applied to the individual VNICs in the subnet.
|
|
subnet_domain_name
string
|
on success |
The subnet's domain name, which consists of the subnet's DNS label, the VCN's DNS label, and the `oraclevcn.com` domain.
For more information, see DNS in Your Virtual Cloud Network.
Example: `subnet123.vcn1.oraclevcn.com`
Sample:
subnet_domain_name_example
|
|
time_created
string
|
on success |
The date and time the subnet 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 subnet is in.
Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
|
|
virtual_router_ip
string
|
on success |
The IP address of the virtual router.
Example: `10.0.14.1`
Sample:
virtual_router_ip_example
|
|
virtual_router_mac
string
|
on success |
The MAC address of the virtual router.
Example: `00:00:00:00:00:01`
Sample:
virtual_router_mac_example
|
Authors¶
Oracle (@oracle)