oci_subnet – Manage subnets in a VCN in OCI

New in version 2.5.

Synopsis

  • This module allows the user to create, delete and update subnets in a VCN in OCI.

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_OCID 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
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.
availability_domain
-
The Availability Domain to contain the subnet. If not specified while using state=present a regional subnet will be created.
cidr_block
-
The CIDR IP address range of the subnet. Required when creating a subnet with state=present.
compartment_id
-
The OCID of the compartment to contain the subnet. Required when creating a subnet with state=present.
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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
dhcp_options_id
-
The OCID of the set of DHCP options the subnet will use. If you don't provide a value, the subnet will use the VCN's default set of DHCP options.
display_name
-
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

aliases: name
dns_label
-
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, bminstance-1.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. This value must be set if you want to use the Internet and VCN Resolver to resolve the hostnames of instances in the subnet. It can only be set if the VCN itself was created with a DNS label.
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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
key_by
list
The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
prohibit_public_ip_on_vnic
boolean
    Choices:
  • no ←
  • yes
Whether VNICs within this subnet can have public IP addresses. If prohibit_public_ip_on_vnic=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 prohibit_public_ip_on_vnic=true, VNICs created in this subnet cannot have public IP addresses (that is, it's a private subnet).
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.
route_table_id
-
The OCID of the route table the subnet will use. If you don't provide a value, the subnet will use the VCN's default route table.
security_list_ids
-
List of OCIDs of security lists to associate with the subnet. If you don't provide a value, the VCN's default security list will be associated with the subnet. Remember that security lists are associated at the subnet level, but the rules are applied to the individual VNICs in the subnet.
state
-
    Choices:
  • present ←
  • absent
Create or update a subnet with state=present. Delete a subnet with state=absent.
subnet_id
-
The OCID of the subnet. Required when deleting a subnet with state=absent or updating a subnet with state=present.

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
-
The OCID of the VCN to contain the subnet. Required when creating a subnet with state=present.
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Default:
1200
Time, in seconds, to wait when wait=yes.
wait_until
string
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Examples

- name: Create a subnet
  oci_subnet:
    availability_domain: BnQb:PHX-AD-1
    cidr_block: 10.0.1.0/24
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    prohibit_public_ip_on_vnic: true
    vcn_id: ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx

- name: Create a regional subnet
  oci_subnet:
    cidr_block: 10.0.1.0/24
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    prohibit_public_ip_on_vnic: true
    vcn_id: ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx

- name: Update subnet's display name and associated route table
  oci_subnet:
    display_name: ansible_subnet
    subnet_id: ocid1.subnet.oc1.phx.xxxxxEXAMPLExxxxx
    route_table_id: "ocid1.routetable.oc1.phx.xxxxxEXAMPLExxxxx"

- name: Update subnet's associated security lists and DHCP options
  oci_subnet:
    subnet_id: ocid1.subnet.oc1.phx.xxxxxEXAMPLExxxxx
    security_list_ids: ["ocid1.securitylist.oc1.phx.xxxxxEXAMPLExxxxx"]
    dhcp_options_id: "ocid1.dhcpoptions.oc1.phx.xxxxxEXAMPLExxxxx"

- name: Delete a subnet
  oci_subnet:
    subnet_id: ocid1.subnet.oc1.phx.xxxxxEXAMPLExxxxx
    state: 'absent'

Return Values

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

Key Returned Description
subnet
dictionary
On successful create and update operation
Information about the subnet

Sample:
{'vcn_id': 'ocid1.vcn.oc1.phx.xxxxxEXAMPLExxxxx', 'subnet_domain_name': 'ansiblesubnet.ansiblevcn.oraclevcn.com', 'availability_domain': 'BnQb:PHX-AD-1', 'time_created': '2017-11-16T03:05:50.992000+00:00', 'route_table_id': 'ocid1.routetable.oc1.phx.xxxxxEXAMPLExxxxx', 'cidr_block': '10.0.1.0/24', 'id': 'ocid1.subnet.oc1.phx.xxxxxEXAMPLExxxxx', 'virtual_router_ip': '10.0.1.1', 'lifecycle_state': 'AVAILABLE', 'dns_label': 'ansiblesubnet', 'display_name': 'ansible_subnet', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'security_list_ids': ['ocid1.securitylist.oc1.phx.xxxxxEXAMPLExxxxx'], 'prohibit_public_ip_on_vnic': True, 'virtual_router_mac': '00:00:17:D1:27:79', 'dhcp_options_id': 'ocid1.dhcpoptions.oc1.phx.xxxxxEXAMPLExxxxx'}


Status

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

Authors

  • Rohit Chaware (@rohitChaware)

Hint

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