oracle.oci.oci_network_byoip_range – Manage a ByoipRange 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_byoip_range
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a ByoipRange resource in Oracle Cloud Infrastructure
For state=present, creates a subrange of the BYOIP CIDR block.
This resource has the following action operations in the oracle.oci.oci_network_byoip_range_actions module: advertise, change_compartment, validate, withdraw.
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
|
|
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. |
byoip_range_id
string
|
The OCID of the `ByoipRange` resource containing the BYOIP CIDR block.
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 |
|
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
|
The BYOIP CIDR block. You can assign some or all of it to a public IP pool after it is validated. Example: `10.0.1.0/24`
|
|
compartment_id
string
|
The OCID of the compartment containing the BYOIP CIDR block.
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 |
|
force_create
boolean
|
|
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_cidr_block
string
|
The BYOIPv6 prefix. You can assign some or all of it to a VCN after it is validated.
|
|
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
|
|
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
|
|
The state of the ByoipRange.
Use state=present to create or update a ByoipRange.
Use state=absent to delete a ByoipRange.
|
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: Create byoip_range
oci_network_byoip_range:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
cidr_block: cidr_block_example
ipv6_cidr_block: ipv6_cidr_block_example
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
- name: Update byoip_range
oci_network_byoip_range:
# required
byoip_range_id: "ocid1.byoiprange.oc1..xxxxxxEXAMPLExxxxxx"
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
- name: Update byoip_range using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_network_byoip_range:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
freeform_tags: {'Department': 'Finance'}
- name: Delete byoip_range
oci_network_byoip_range:
# required
byoip_range_id: "ocid1.byoiprange.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete byoip_range using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_network_byoip_range:
# 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 | ||
---|---|---|---|---|
byoip_range
complex
|
on success |
Details of the ByoipRange resource acted upon by the current operation
Sample:
{'byoip_range_vcn_ipv6_allocations': [{'byoip_range_id': 'ocid1.byoiprange.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'ipv6_cidr_block': 'ipv6_cidr_block_example', 'vcn_id': 'ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx'}], 'cidr_block': 'cidr_block_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ipv6_cidr_block': 'ipv6_cidr_block_example', 'lifecycle_details': 'CREATING', 'lifecycle_state': 'INACTIVE', 'time_advertised': '2013-10-20T19:20:30+01:00', 'time_created': '2013-10-20T19:20:30+01:00', 'time_validated': '2013-10-20T19:20:30+01:00', 'time_withdrawn': '2013-10-20T19:20:30+01:00', 'validation_token': 'validation_token_example'}
|
||
byoip_range_vcn_ipv6_allocations
complex
|
on success |
A list of `ByoipRangeVcnIpv6AllocationSummary` objects.
|
||
byoip_range_id
string
|
on success |
The OCID of the `ByoipRange` resource to which the CIDR block belongs.
Sample:
ocid1.byoiprange.oc1..xxxxxxEXAMPLExxxxxx
|
||
compartment_id
string
|
on success |
The OCID of the compartment containing the `ByoipRange`.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
ipv6_cidr_block
string
|
on success |
The BYOIPv6 prefix range or subrange allocated to a VCN. This could be all or part of a BYOIPv6 prefix. Each VCN allocation must be /64 or larger.
Sample:
ipv6_cidr_block_example
|
||
vcn_id
string
|
on success |
The OCID of the `Vcn` resource to which the ByoipRange belongs.
Sample:
ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
|
||
cidr_block
string
|
on success |
The public IPv4 CIDR block being imported from on-premises to the Oracle cloud.
Sample:
cidr_block_example
|
||
compartment_id
string
|
on success |
The OCID of the compartment containing the BYOIP CIDR block.
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'}}
|
||
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
|
||
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 OCID of the `ByoipRange` resource.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
ipv6_cidr_block
string
|
on success |
The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be also assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.
Sample:
ipv6_cidr_block_example
|
||
lifecycle_details
string
|
on success |
The `ByoipRange` resource's current status.
Sample:
CREATING
|
||
lifecycle_state
string
|
on success |
The `ByoipRange` resource's current state.
Sample:
INACTIVE
|
||
time_advertised
string
|
on success |
The date and time the `ByoipRange` resource was advertised to the internet by BGP, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
||
time_created
string
|
on success |
The date and time the `ByoipRange` resource was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
||
time_validated
string
|
on success |
The date and time the `ByoipRange` resource was validated, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
||
time_withdrawn
string
|
on success |
The date and time the `ByoipRange` resource was withdrawn from advertisement by BGP to the internet, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`
Sample:
2013-10-20T19:20:30+01:00
|
||
validation_token
string
|
on success |
The validation token is an internally-generated ASCII string used in the validation process. See Importing a CIDR block for details.
Sample:
validation_token_example
|
Authors¶
Oracle (@oracle)