Try SpotterManage a Vcn resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0This module allows the user to create, update and delete a Vcn resource in Oracle Cloud Infrastructure
For I(state=present), creates a new virtual cloud network (VCN). For more information, see L(VCNs and Subnets,https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVCNs.htm).
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 L(RFC 1918,https://tools.ietf.org/html/rfc1918) (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 L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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 L(Overview of the IAM Service,https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see L(Resource Identifiers,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
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 L(DNS in Your Virtual Cloud Network,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
The VCN automatically comes with a default route table, default security list, and default set of DHCP options. The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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 L(Overview of the Networking Service,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/overview.htm).
This resource has the following action operations in the M(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.
- 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
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 Vcn.
- Use I(state=present) to create or update a Vcn.
- Use I(state=absent) to delete a Vcn.
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
vcn_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the VCN.
- 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
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
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
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
dns_label:
description:
- 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 L(DNS in Your Virtual Cloud Network,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
- 'Example: `vcn1`'
type: str
cidr_block:
description:
- '**Deprecated.** Do *not* set this value. Use `cidrBlocks` instead. Example: `10.0.0.0/16`'
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
cidr_blocks:
description:
- '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.'
elements: str
type: list
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/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
- This parameter is updatable.
type: dict
display_name:
aliases:
- name
description:
- 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 C(OCI_USE_NAME_AS_IDENTIFIER)
is set.
- This parameter is updatable when C(OCI_USE_NAME_AS_IDENTIFIER) is not set.
type: str
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/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
- This parameter is updatable.
type: dict
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment to contain the VCN.
- 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
is_ipv6_enabled:
description:
- 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 L(IPv6 Addresses,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
- 'Example: `true`'
type: bool
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
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
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
byoipv6_cidr_details:
description:
- The list of BYOIPv6 OCIDs and BYOIPv6 prefixes required to create a VCN that uses
BYOIPv6 address ranges.
elements: dict
suboptions:
byoipv6_range_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the `ByoipRange` resource to which the CIDR block belongs.
required: true
type: str
ipv6_cidr_block:
description:
- '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`'
required: true
type: str
type: list
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
ipv6_private_cidr_blocks:
description:
- '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.'
elements: str
type: list
is_oracle_gua_allocation_enabled:
description:
- Specifies whether to skip Oracle allocated IPv6 GUA. By default, Oracle will allocate
one GUA of /56 size for an IPv6 enabled VCN.
type: bool
realm_specific_endpoint_template_enabled:
description:
- 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.
type: bool
vcn:
contains:
byoipv6_cidr_blocks:
description:
- The list of BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 ranges.
returned: on success
sample: []
type: list
cidr_block:
description:
- Deprecated. The first CIDR IP address from cidrBlocks.
- 'Example: `172.16.0.0/16`'
returned: on success
sample: cidr_block_example
type: str
cidr_blocks:
description:
- The list of IPv4 CIDR blocks the VCN will use.
returned: on success
sample: []
type: list
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment containing the VCN.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
default_dhcp_options_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
for the VCN's default set of DHCP options.
returned: on success
sample: ocid1.defaultdhcpoptions.oc1..xxxxxxEXAMPLExxxxxx
type: str
default_route_table_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
for the VCN's default route table.
returned: on success
sample: ocid1.defaultroutetable.oc1..xxxxxxEXAMPLExxxxxx
type: str
default_security_list_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
for the VCN's default security list.
returned: on success
sample: ocid1.defaultsecuritylist.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/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable. Avoid
entering confidential information.
returned: on success
sample: display_name_example
type: str
dns_label:
description:
- 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 L(DNS in Your Virtual Cloud Network,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
- 'Example: `vcn1`'
returned: on success
sample: dns_label_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/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
id:
description:
- The VCN's Oracle ID (L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
ipv6_cidr_blocks:
description:
- 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.
returned: on success
sample: []
type: list
ipv6_private_cidr_blocks:
description:
- For an IPv6-enabled VCN, this is the list of Private IPv6 prefixes for the
VCN's IP address space.
returned: on success
sample: []
type: list
lifecycle_state:
description:
- The VCN's current state.
returned: on success
sample: PROVISIONING
type: str
time_created:
description:
- The date and time the VCN was created, in the format defined by L(RFC3339,https://tools.ietf.org/html/rfc3339).
- 'Example: `2016-08-25T21:10:29.600Z`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
vcn_domain_name:
description:
- The VCN's domain name, which consists of the VCN's DNS label, and the `oraclevcn.com`
domain.
- For more information, see L(DNS in Your Virtual Cloud Network,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
- 'Example: `vcn1.oraclevcn.com`'
returned: on success
sample: vcn_domain_name_example
type: str
description:
- Details of the Vcn resource acted upon by the current operation
returned: on success
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
type: complex