oracle.oci.oci_network_byoip_range_actions – Perform actions on a ByoipRange resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a ByoipRange resource in Oracle Cloud Infrastructure

  • For action=advertise, begins BGP route advertisements for the BYOIP CIDR block you imported to the Oracle Cloud. The ByoipRange resource must be in the PROVISIONED state before the BYOIP CIDR block routes can be advertised with BGP.

  • For action=change_compartment, moves a BYOIP CIDR block to a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

  • For action=validate, submits the BYOIP CIDR block you are importing for validation. Do not submit to Oracle for validation if you have not already modified the information for the BYOIP CIDR block with your Regional Internet Registry. See To import a CIDR block for details.

  • For action=withdraw, withdraws BGP route advertisement for the BYOIP CIDR block.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • advertise
  • change_compartment
  • validate
  • withdraw
The action to perform on the ByoipRange.
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
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 / required
The OCID of the `ByoipRange` resource containing the BYOIP CIDR block.

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.
compartment_id
string
The OCID of the destination compartment for the BYOIP CIDR block move.
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.
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.
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
    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.

Examples

- name: Perform action advertise on byoip_range
  oci_network_byoip_range_actions:
    # required
    byoip_range_id: "ocid1.byoiprange.oc1..xxxxxxEXAMPLExxxxxx"
    action: advertise

- name: Perform action change_compartment on byoip_range
  oci_network_byoip_range_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    byoip_range_id: "ocid1.byoiprange.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

- name: Perform action validate on byoip_range
  oci_network_byoip_range_actions:
    # required
    byoip_range_id: "ocid1.byoiprange.oc1..xxxxxxEXAMPLExxxxxx"
    action: validate

- name: Perform action withdraw on byoip_range
  oci_network_byoip_range_actions:
    # required
    byoip_range_id: "ocid1.byoiprange.oc1..xxxxxxEXAMPLExxxxxx"
    action: withdraw

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 CIDR block range or subrange allocated to a VCN. This could be all or part of a BYOIPv6 CIDR block. 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 CIDR block being imported to the Oracle cloud. This CIDR block 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)