oracle.oci.oci_network_vcn – Manage a Vcn resource in Oracle Cloud Infrastructure¶

Note

This plugin is part of the oracle.oci collection (version 5.3.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_vcn.

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

This module allows the user to create, update and delete a Vcn resource in Oracle Cloud Infrastructure
For state=present, creates a new virtual cloud network (VCN). For more information, see VCNs and Subnets.
For the VCN, you specify a list of one or more IPv4 CIDR blocks that meet the following criteria:
- The CIDR blocks must be valid. - They must not overlap with each other or with the on-premises network CIDR block. - The number of CIDR blocks does not exceed the limit of CIDR blocks allowed per VCN.
For a CIDR block, Oracle recommends that you use one of the private IP address ranges specified in RFC 1918 (10.0.0.0/8, 172.16/12, and 192.168/16). Example: 172.16.0.0/16. The CIDR blocks can range from /16 to /30.
For the purposes of access control, you must provide the OCID of the compartment where you want the VCN to reside. Consult an Oracle Cloud Infrastructure administrator in your organization if you’re not sure which compartment to use. Notice that the VCN doesn’t have to be in the same compartment as the subnets or other Networking Service components. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
You may optionally specify a display name for the VCN, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
You can also add a DNS label for the VCN, which is required if you want the instances to use the Interent and VCN Resolver option for DNS in the VCN. For more information, see DNS in Your Virtual Cloud Network.
The VCN automatically comes with a default route table, default security list, and default set of DHCP options. The OCID for each is returned in the response. You can’t delete these default objects, but you can change their contents (that is, change the route rules, security list rules, and so on).
The VCN and subnets you create are not accessible until you attach an internet gateway or set up a Site-to-Site VPN or FastConnect. For more information, see Overview of the Networking Service.
This resource has the following action operations in the oracle.oci.oci_network_vcn_actions module: add_ipv6_vcn_cidr, add_vcn_cidr, change_compartment, modify_vcn_cidr, remove_ipv6_vcn_cidr, remove_vcn_cidr.

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
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		Choices: service_principal	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		Choices: api_key ← instance_principal instance_obo_user resource_principal security_token	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.
byoipv6_cidr_details list / elements=dictionary			The list of BYOIPv6 OCIDs and BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 address ranges.
	byoipv6_range_id string / required		The OCID of the `ByoipRange` resource to which the CIDR block belongs.
	ipv6_cidr_block string / required		An IPv6 prefix required to create a VCN with a BYOIP prefix. It could be the whole prefix identified in `byoipv6RangeId`, or a subrange. Example: `2001:0db8:0123::/48`
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.
cidr_block string			Deprecated. Do not set this value. Use `cidrBlocks` instead. Example: `10.0.0.0/16`
cidr_blocks list / elements=string			The list of one or more IPv4 CIDR blocks for the VCN that meet the following criteria: - The CIDR blocks must be valid. - They must not overlap with each other or with the on-premises network CIDR block. - The number of CIDR blocks must not exceed the limit of CIDR blocks allowed per VCN. Important: Do not specify a value for `cidrBlock`. Use this parameter instead.
compartment_id string			The OCID of the compartment to contain the VCN. Required for create using state=present. Required for update when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is set. Required for delete when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is set.
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 Resource Tags. Example: `{"Operations": {"CostCenter": "42"}}` This parameter is updatable.
display_name string			A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Required for create, update, delete when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is set. This parameter is updatable when `OCI_USE_NAME_AS_IDENTIFIER` is not set. aliases: name
dns_label string			A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`). Not required to be unique, but it's a best practice to set unique DNS labels for VCNs in your tenancy. Must be an alphanumeric string that begins with a letter. The value cannot be changed. You must set this value if you want instances to be able to use hostnames to resolve other instances in the VCN. Otherwise the Internet and VCN Resolver will not work. For more information, see DNS in Your Virtual Cloud Network. Example: `vcn1`
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 Resource Tags. Example: `{"Department": "Finance"}` This parameter is updatable.
ipv6_private_cidr_blocks list / elements=string			The list of one or more ULA or Private IPv6 prefixes for the VCN that meets the following criteria: - The CIDR blocks must be valid. - Multiple CIDR blocks must not overlap each other or the on-premises network prefix. - The number of CIDR blocks must not exceed the limit of IPv6 prefixes allowed to a VCN. Important: Do not specify a value for `ipv6CidrBlock`. Use this parameter instead.
is_ipv6_enabled boolean		Choices: no yes	Whether IPv6 is enabled for the VCN. Default is `false`. If enabled, Oracle will assign the VCN a IPv6 /56 CIDR block. You may skip having Oracle allocate the VCN a IPv6 /56 CIDR block by setting isOracleGuaAllocationEnabled to `false`. For important details about IPv6 addressing in a VCN, see IPv6 Addresses. Example: `true`
is_oracle_gua_allocation_enabled boolean		Choices: no yes	Specifies whether to skip Oracle allocated IPv6 GUA. By default, Oracle will allocate one GUA of /56 size for an IPv6 enabled VCN.
key_by list / elements=string			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.
realm_specific_endpoint_template_enabled boolean		Choices: no yes	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.
state string		Choices: present ← absent	The state of the Vcn. Use state=present to create or update a Vcn. Use state=absent to delete a Vcn.
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 string			The OCID of the VCN. Required for update using state=present when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is not set. Required for delete using state=absent when environment variable `OCI_USE_NAME_AS_IDENTIFIER` is not set. aliases: id
wait boolean		Choices: no yes ←	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: Create vcn
  oci_network_vcn:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    cidr_block: cidr_block_example
    cidr_blocks: [ "cidr_blocks_example" ]
    ipv6_private_cidr_blocks: [ "ipv6_private_cidr_blocks_example" ]
    is_oracle_gua_allocation_enabled: true
    byoipv6_cidr_details:
    - # required
      byoipv6_range_id: "ocid1.byoipv6range.oc1..xxxxxxEXAMPLExxxxxx"
      ipv6_cidr_block: ipv6_cidr_block_example
    dns_label: dns_label_example
    is_ipv6_enabled: true
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}

- name: Update vcn
  oci_network_vcn:
    # required
    vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}

- name: Update vcn using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_network_vcn:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}

- name: Delete vcn
  oci_network_vcn:
    # required
    vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete vcn using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_network_vcn:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values ¶

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

Key		Returned	Description
vcn complex		on success	Details of the Vcn resource acted upon by the current operation Sample: {'byoipv6_cidr_blocks': [], 'cidr_block': 'cidr_block_example', 'cidr_blocks': [], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'default_dhcp_options_id': 'ocid1.defaultdhcpoptions.oc1..xxxxxxEXAMPLExxxxxx', 'default_route_table_id': 'ocid1.defaultroutetable.oc1..xxxxxxEXAMPLExxxxxx', 'default_security_list_id': 'ocid1.defaultsecuritylist.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'dns_label': 'dns_label_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ipv6_cidr_blocks': [], 'ipv6_private_cidr_blocks': [], 'lifecycle_state': 'PROVISIONING', 'time_created': '2013-10-20T19:20:30+01:00', 'vcn_domain_name': 'vcn_domain_name_example'}
	byoipv6_cidr_blocks list / elements=string	on success	The list of BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 ranges.
	cidr_block string	on success	Deprecated. The first CIDR IP address from cidrBlocks. Example: `172.16.0.0/16` Sample: cidr_block_example
	cidr_blocks list / elements=string	on success	The list of IPv4 CIDR blocks the VCN will use.
	compartment_id string	on success	The OCID of the compartment containing the VCN. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
	default_dhcp_options_id string	on success	The OCID for the VCN's default set of DHCP options. Sample: ocid1.defaultdhcpoptions.oc1..xxxxxxEXAMPLExxxxxx
	default_route_table_id string	on success	The OCID for the VCN's default route table. Sample: ocid1.defaultroutetable.oc1..xxxxxxEXAMPLExxxxxx
	default_security_list_id string	on success	The OCID for the VCN's default security list. Sample: ocid1.defaultsecuritylist.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'}}
	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 VCN, used in conjunction with the VNIC's hostname and subnet'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. The value cannot be changed. The absence of this parameter means the Internet and VCN Resolver will not work for this VCN. For more information, see DNS in Your Virtual Cloud Network. Example: `vcn1` 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 VCN's Oracle ID (OCID). Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	ipv6_cidr_blocks list / elements=string	on success	For an IPv6-enabled VCN, this is the list of IPv6 prefixes for the VCN's IP address space. The prefixes are provided by Oracle and the sizes are always /56.
	ipv6_private_cidr_blocks list / elements=string	on success	For an IPv6-enabled VCN, this is the list of Private IPv6 prefixes for the VCN's IP address space.
	lifecycle_state string	on success	The VCN's current state. Sample: PROVISIONING
	time_created string	on success	The date and time the VCN was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` Sample: 2013-10-20T19:20:30+01:00
	vcn_domain_name string	on success	The VCN's domain name, which consists of the VCN's DNS label, and the `oraclevcn.com` domain. For more information, see DNS in Your Virtual Cloud Network. Example: `vcn1.oraclevcn.com` Sample: vcn_domain_name_example

Authors¶

Oracle (@oracle)

oracle.oci.oci_network_vcn – Manage a Vcn resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶