oracle.oci.oci_compute_cloud_at_customer_ccc_infrastructure – Manage a CccInfrastructure resource in Oracle Cloud Infrastructure

Note

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

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a CccInfrastructure resource in Oracle Cloud Infrastructure

  • For state=present, creates a Compute Cloud@Customer infrastructure. Once created, Oracle Services must connect the rack in the data center to this Oracle Cloud Infrastructure resource.

  • This resource has the following action operations in the oracle.oci.oci_compute_cloud_at_customer_ccc_infrastructure_actions module: change_compartment.

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_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.
ccc_infrastructure_id
string
An OCID for a Compute Cloud@Customer Infrastructure.
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
ccc_upgrade_schedule_id
string
Schedule used for upgrades. If no schedule is associated with the infrastructure, it can be upgraded at any time.
This parameter is updatable.
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 compartment OCID associated with the infrastructure.
Required for create using 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.
connection_details
string
A message describing the current connection state in more detail.
This parameter is updatable.
connection_state
string
The current connection state of the Compute Cloud@Customer infrastructure. This value will default to REJECT if the value is not provided. The only valid value at creation time is REJECT.
This parameter is updatable.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
description
string
A mutable client-meaningful text description of the Compute Cloud@Customer infrastructure. Avoid entering confidential information.
This parameter is updatable.
display_name
string
The name that will be used to display the Compute Cloud@Customer infrastructure in the Oracle Cloud Infrastructure console. Does not have to be unique and can be changed. Avoid entering confidential information.
Required for create using state=present.
Required for 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
    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
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
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 CccInfrastructure.
Use state=present to create or update a CccInfrastructure.
Use state=absent to delete a CccInfrastructure.
subnet_id
string
Identifier for network subnet that will be used to communicate with Compute Cloud@Customer infrastructure.
Required for create using state=present.
This parameter is updatable.
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: Create ccc_infrastructure
  oci_compute_cloud_at_customer_ccc_infrastructure:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    description: description_example
    connection_state: connection_state_example
    connection_details: connection_details_example
    ccc_upgrade_schedule_id: "ocid1.cccupgradeschedule.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update ccc_infrastructure
  oci_compute_cloud_at_customer_ccc_infrastructure:
    # required
    ccc_infrastructure_id: "ocid1.cccinfrastructure.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    display_name: display_name_example
    description: description_example
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
    connection_state: connection_state_example
    connection_details: connection_details_example
    ccc_upgrade_schedule_id: "ocid1.cccupgradeschedule.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update ccc_infrastructure using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_compute_cloud_at_customer_ccc_infrastructure:
    # required
    display_name: display_name_example

    # optional
    description: description_example
    subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
    connection_state: connection_state_example
    connection_details: connection_details_example
    ccc_upgrade_schedule_id: "ocid1.cccupgradeschedule.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete ccc_infrastructure
  oci_compute_cloud_at_customer_ccc_infrastructure:
    # required
    ccc_infrastructure_id: "ocid1.cccinfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete ccc_infrastructure using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_compute_cloud_at_customer_ccc_infrastructure:
    # required
    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
ccc_infrastructure
complex
on success
Details of the CccInfrastructure resource acted upon by the current operation

Sample:
{'ccc_upgrade_schedule_id': 'ocid1.cccupgradeschedule.oc1..xxxxxxEXAMPLExxxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connection_details': 'connection_details_example', 'connection_state': 'REJECT', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'infrastructure_inventory': {'capacity_storage_tray_count': 56, 'compute_node_count': 56, 'management_node_count': 56, 'performance_storage_tray_count': 56, 'serial_number': 'serial_number_example'}, 'infrastructure_network_configuration': {'dns_ips': [], 'infrastructure_routing_dynamic': {'bgp_topology': 'TRIANGLE', 'oracle_asn': 56, 'peer_information': [{'asn': 56, 'ip': 'ip_example'}]}, 'infrastructure_routing_static': {'uplink_hsrp_group': 56, 'uplink_vlan': 56}, 'management_nodes': [{'hostname': 'hostname_example', 'ip': 'ip_example'}], 'mgmt_vip_hostname': 'mgmt_vip_hostname_example', 'mgmt_vip_ip': 'mgmt_vip_ip_example', 'spine_ips': [], 'spine_vip': 'spine_vip_example', 'uplink_domain': 'uplink_domain_example', 'uplink_gateway_ip': 'uplink_gateway_ip_example', 'uplink_netmask': 'uplink_netmask_example', 'uplink_port_count': 56, 'uplink_port_forward_error_correction': 'AUTO', 'uplink_port_speed_in_gbps': 56, 'uplink_vlan_mtu': 56}, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACTIVE', 'provisioning_fingerprint': 'provisioning_fingerprint_example', 'provisioning_pin': 'provisioning_pin_example', 'short_name': 'short_name_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'upgrade_information': {'current_version': 'current_version_example', 'is_active': True, 'scheduled_upgrade_duration': 'scheduled_upgrade_duration_example', 'time_of_scheduled_upgrade': '2013-10-20T19:20:30+01:00'}}
 
ccc_upgrade_schedule_id
string
on success
Schedule used for upgrades. If no schedule is associated with the infrastructure, it can be updated at any time.

Sample:
ocid1.cccupgradeschedule.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
The infrastructure compartment OCID.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
connection_details
string
on success
A message describing the current connection state in more detail.

Sample:
connection_details_example
 
connection_state
string
on success
The current connection state of the infrastructure. A user can only update it from REQUEST to READY or from any state back to REJECT. The system automatically handles the REJECT to REQUEST, READY to CONNECTED, or CONNECTED to DISCONNECTED transitions.

Sample:
REJECT
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
A mutable client-meaningful text description of the Compute Cloud@Customer infrastructure. Avoid entering confidential information.

Sample:
description_example
 
display_name
string
on success
The name that will be used to display the Compute Cloud@Customer infrastructure in the Oracle Cloud Infrastructure console. Does not have to be unique and can be changed. Avoid entering confidential information.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The Compute Cloud@Customer infrastructure OCID. This cannot be changed once created.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
infrastructure_inventory
complex
on success

   
capacity_storage_tray_count
integer
on success
The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for capacity storage.

Sample:
56
   
compute_node_count
integer
on success
The number of compute nodes that are available and usable on the Compute Cloud@Customer infrastructure rack. There is no distinction of compute node type in this information.

Sample:
56
   
management_node_count
integer
on success
The number of management nodes that are available and in active use on the Compute Cloud@Customer infrastructure rack.

Sample:
56
   
performance_storage_tray_count
integer
on success
The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for performance storage.

Sample:
56
   
serial_number
string
on success
The serial number of the Compute Cloud@Customer infrastructure rack.

Sample:
serial_number_example
 
infrastructure_network_configuration
complex
on success

   
dns_ips
list / elements=string
on success
The domain name system (DNS) addresses that the Compute Cloud@Customer infrastructure uses for the data center network.
   
infrastructure_routing_dynamic
complex
on success

     
bgp_topology
string
on success
The topology in use for the Border Gateway Protocol (BGP) configuration.

Sample:
TRIANGLE
     
oracle_asn
integer
on success
The Oracle Autonomous System Number (ASN) to control routing and exchange information within the dynamic routing configuration.

Sample:
56
     
peer_information
complex
on success
The list of peer devices in the dynamic routing configuration.
       
asn
integer
on success
The Autonomous System Number (ASN) of the peer network.

Sample:
56
       
ip
string
on success
Neighbor Border Gateway Protocal (BGP) IP address. The IP address usually refers to the customer data center router.

Sample:
ip_example
   
infrastructure_routing_static
complex
on success

      uplink_hsrp_group
integer
on success
The uplink Hot Standby Router Protocol (HSRP) group value for the switch in the Compute Cloud@Customer infrastructure.

Sample:
56
      uplink_vlan
integer
on success
The virtual local area network (VLAN) identifier used to connect to the uplink (only access mode is supported).

Sample:
56
   
management_nodes
complex
on success
Information about the management nodes that are provisioned in the Compute Cloud@Customer infrastructure.
     
hostname
string
on success
Hostname for interface to the management node.

Sample:
hostname_example
     
ip
string
on success
Address of the management node.

Sample:
ip_example
   
mgmt_vip_hostname
string
on success
The hostname corresponding to the virtual IP (VIP) address of the management nodes.

Sample:
mgmt_vip_hostname_example
   
mgmt_vip_ip
string
on success
The IP address used as the virtual IP (VIP) address of the management nodes.

Sample:
mgmt_vip_ip_example
   
spine_ips
list / elements=string
on success
Addresses of the network spine switches.
   
spine_vip
string
on success
The spine switch public virtual IP (VIP). Traffic routed to the Compute Cloud@Customer infrastructure and and virtual cloud networks (VCNs) should have this address as next hop.

Sample:
spine_vip_example
    uplink_domain
string
on success
Domain name to be used as the base domain for the internal network and by public facing services.

Sample:
uplink_domain_example
    uplink_gateway_ip
string
on success
Uplink gateway in the datacenter network that the Compute Cloud@Customer connects to.

Sample:
uplink_gateway_ip_example
    uplink_netmask
string
on success
Netmask of the subnet that the Compute Cloud@Customer infrastructure is connected to.

Sample:
uplink_netmask_example
    uplink_port_count
integer
on success
Number of uplink ports per spine switch. Connectivity is identical on both spine switches. For example, if input is two 100 gigabyte ports; then port-1 and port-2 on both spines will be configured.

Sample:
56
    uplink_port_forward_error_correction
string
on success
The port forward error correction (FEC) setting for the uplink port on the Compute Cloud@Customer infrastructure.

Sample:
AUTO
    uplink_port_speed_in_gbps
integer
on success
Uplink port speed defined in gigabytes per second. All uplink ports must have identical speed.

Sample:
56
    uplink_vlan_mtu
integer
on success
The virtual local area network (VLAN) maximum transmission unit (MTU) size for the uplink ports.

Sample:
56
 
lifecycle_details
string
on success
A message describing the current lifecycle state in more detail. For example, this can be used to provide actionable information for a resource that is in a Failed state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the Compute Cloud@Customer infrastructure.

Sample:
ACTIVE
 
provisioning_fingerprint
string
on success
Fingerprint of a Compute Cloud@Customer infrastructure in a data center generated during the initial connection to this resource. The fingerprint should be verified by the administrator when changing the connectionState from REQUEST to READY.

Sample:
provisioning_fingerprint_example
 
provisioning_pin
string
on success
Code that is required for service personnel to connect a Compute Cloud@Customer infrastructure in a data center to this resource. This code will only be available when the connectionState is REJECT (usually at create time of the Compute Cloud@Customer infrastructure).

Sample:
provisioning_pin_example
 
short_name
string
on success
The Compute Cloud@Customer infrastructure short name. This cannot be changed once created. The short name is used to refer to the infrastructure in several contexts and is unique.

Sample:
short_name_example
 
subnet_id
string
on success
OCID for the network subnet that is used to communicate with Compute Cloud@Customer infrastructure.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
system_tags
dictionary
on success
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
 
time_created
string
on success
Compute Cloud@Customer infrastructure creation date and time, using an RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
Compute Cloud@Customer infrastructure updated date and time, using an RFC3339 formatted datetime string.

Sample:
2013-10-20T19:20:30+01:00
 
upgrade_information
complex
on success

   
current_version
string
on success
The current version of software installed on the Compute Cloud@Customer infrastructure.

Sample:
current_version_example
   
is_active
boolean
on success
Indication that the Compute Cloud@Customer infrastructure is in the process of an upgrade or an upgrade activity (such as preloading upgrade images).

Sample:
True
   
scheduled_upgrade_duration
string
on success
Expected duration of Compute Cloud@Customer infrastructure scheduled upgrade. The actual upgrade time might be longer or shorter than this duration depending on rack activity, this is only an estimate.

Sample:
scheduled_upgrade_duration_example
   
time_of_scheduled_upgrade
string
on success
Compute Cloud@Customer infrastructure next upgrade time. The rack might have performance impacts during this time.

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)