Try SpotterFetches details about one or multiple CccInfrastructure resources 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.0Fetches details about one or multiple CccInfrastructure resources in Oracle Cloud Infrastructure
Returns a list of Compute Cloud@Customer infrastructures.
If I(ccc_infrastructure_id) is specified, the details of a single CccInfrastructure will be returned.
- name: Get a specific ccc_infrastructure
oci_compute_cloud_at_customer_ccc_infrastructure_facts:
# required
ccc_infrastructure_id: "ocid1.cccinfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
- name: List ccc_infrastructures
oci_compute_cloud_at_customer_ccc_infrastructure_facts:
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id_in_subtree: true
access_level: RESTRICTED
lifecycle_state: ACTIVE
display_name: display_name_example
display_name_contains: display_name_contains_example
ccc_infrastructure_id: "ocid1.cccinfrastructure.oc1..xxxxxxEXAMPLExxxxxx"
sort_order: ASC
sort_by: timeCreated
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
sort_by:
choices:
- timeCreated
- displayName
description:
- The field to sort by. Only one sort order may be provided. Default order for timeCreated
is descending. Default order for displayName is ascending.
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
sort_order:
choices:
- ASC
- DESC
description:
- The sort order to use, either 'ASC' or 'DESC'.
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
access_level:
choices:
- RESTRICTED
- ACCESSIBLE
description:
- Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this
to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions
directly or indirectly (permissions can be on a resource in a subcompartment). When
set to RESTRICTED permissions are checked and no partial results are displayed.
type: str
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
display_name:
aliases:
- name
description:
- A filter to return only resources that match the entire display name given.
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment in which to list resources.
type: str
lifecycle_state:
choices:
- ACTIVE
- NEEDS_ATTENTION
- DELETED
- FAILED
description:
- A filter used to return only resources that match the given lifecycleState.
type: str
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
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
ccc_infrastructure_id:
aliases:
- id
description:
- An L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
for a Compute Cloud@Customer Infrastructure.
- Required to get a specific ccc_infrastructure.
type: str
display_name_contains:
description:
- A filter to return only resources whose display name contains the substring.
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
compartment_id_in_subtree:
description:
- Default is false. When set to true, the hierarchy of compartments is traversed and
all compartments and sub-compartments in the tenancy are returned. Depends on the
'accessLevel' setting.
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
ccc_infrastructures:
contains:
ccc_upgrade_schedule_id:
description:
- Schedule used for upgrades. If no schedule is associated with the infrastructure,
it can be updated at any time.
- Returned for get operation
returned: on success
sample: ocid1.cccupgradeschedule.oc1..xxxxxxEXAMPLExxxxxx
type: str
compartment_id:
description:
- The infrastructure compartment L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
connection_details:
description:
- A message describing the current connection state in more detail.
- Returned for get operation
returned: on success
sample: connection_details_example
type: str
connection_state:
description:
- 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.
returned: on success
sample: REJECT
type: str
defined_tags:
description:
- 'Defined tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
description:
description:
- A mutable client-meaningful text description of the Compute Cloud@Customer
infrastructure. Avoid entering confidential information.
- Returned for get operation
returned: on success
sample: description_example
type: str
display_name:
description:
- 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.
returned: on success
sample: display_name_example
type: str
freeform_tags:
description:
- 'Simple key-value pair that is applied without any predefined name, type or
scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`'
returned: on success
sample:
Department: Finance
type: dict
id:
description:
- The Compute Cloud@Customer infrastructure L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
This cannot be changed once created.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
infrastructure_inventory:
contains:
capacity_storage_tray_count:
description:
- The number of storage trays in the Compute Cloud@Customer infrastructure
rack that are designated for capacity storage.
returned: on success
sample: 56
type: int
compute_node_count:
description:
- 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.
returned: on success
sample: 56
type: int
management_node_count:
description:
- The number of management nodes that are available and in active use on
the Compute Cloud@Customer infrastructure rack.
returned: on success
sample: 56
type: int
performance_storage_tray_count:
description:
- The number of storage trays in the Compute Cloud@Customer infrastructure
rack that are designated for performance storage.
returned: on success
sample: 56
type: int
serial_number:
description:
- The serial number of the Compute Cloud@Customer infrastructure rack.
returned: on success
sample: serial_number_example
type: str
description:
- ''
- Returned for get operation
returned: on success
type: complex
infrastructure_network_configuration:
contains:
dns_ips:
description:
- The domain name system (DNS) addresses that the Compute Cloud@Customer
infrastructure uses for the data center network.
returned: on success
sample: []
type: list
infrastructure_routing_dynamic:
contains:
bgp_topology:
description:
- The topology in use for the Border Gateway Protocol (BGP) configuration.
returned: on success
sample: TRIANGLE
type: str
oracle_asn:
description:
- The Oracle Autonomous System Number (ASN) to control routing and exchange
information within the dynamic routing configuration.
returned: on success
sample: 56
type: int
peer_information:
contains:
asn:
description:
- The Autonomous System Number (ASN) of the peer network.
returned: on success
sample: 56
type: int
ip:
description:
- Neighbor Border Gateway Protocal (BGP) IP address. The IP address
usually refers to the customer data center router.
returned: on success
sample: ip_example
type: str
description:
- The list of peer devices in the dynamic routing configuration.
returned: on success
type: complex
description:
- ''
returned: on success
type: complex
infrastructure_routing_static:
contains:
uplink_hsrp_group:
description:
- The uplink Hot Standby Router Protocol (HSRP) group value for the
switch in the Compute Cloud@Customer infrastructure.
returned: on success
sample: 56
type: int
uplink_vlan:
description:
- The virtual local area network (VLAN) identifier used to connect to
the uplink (only access mode is supported).
returned: on success
sample: 56
type: int
description:
- ''
returned: on success
type: complex
management_nodes:
contains:
hostname:
description:
- Hostname for interface to the management node.
returned: on success
sample: hostname_example
type: str
ip:
description:
- Address of the management node.
returned: on success
sample: ip_example
type: str
description:
- Information about the management nodes that are provisioned in the Compute
Cloud@Customer infrastructure.
returned: on success
type: complex
mgmt_vip_hostname:
description:
- The hostname corresponding to the virtual IP (VIP) address of the management
nodes.
returned: on success
sample: mgmt_vip_hostname_example
type: str
mgmt_vip_ip:
description:
- The IP address used as the virtual IP (VIP) address of the management
nodes.
returned: on success
sample: mgmt_vip_ip_example
type: str
spine_ips:
description:
- Addresses of the network spine switches.
returned: on success
sample: []
type: list
spine_vip:
description:
- 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.
returned: on success
sample: spine_vip_example
type: str
uplink_domain:
description:
- Domain name to be used as the base domain for the internal network and
by public facing services.
returned: on success
sample: uplink_domain_example
type: str
uplink_gateway_ip:
description:
- Uplink gateway in the datacenter network that the Compute Cloud@Customer
connects to.
returned: on success
sample: uplink_gateway_ip_example
type: str
uplink_netmask:
description:
- Netmask of the subnet that the Compute Cloud@Customer infrastructure is
connected to.
returned: on success
sample: uplink_netmask_example
type: str
uplink_port_count:
description:
- 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.
returned: on success
sample: 56
type: int
uplink_port_forward_error_correction:
description:
- The port forward error correction (FEC) setting for the uplink port on
the Compute Cloud@Customer infrastructure.
returned: on success
sample: AUTO
type: str
uplink_port_speed_in_gbps:
description:
- Uplink port speed defined in gigabytes per second. All uplink ports must
have identical speed.
returned: on success
sample: 56
type: int
uplink_vlan_mtu:
description:
- The virtual local area network (VLAN) maximum transmission unit (MTU)
size for the uplink ports.
returned: on success
sample: 56
type: int
description:
- ''
- Returned for get operation
returned: on success
type: complex
lifecycle_details:
description:
- 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.
- Returned for get operation
returned: on success
sample: lifecycle_details_example
type: str
lifecycle_state:
description:
- The current state of the Compute Cloud@Customer infrastructure.
returned: on success
sample: ACTIVE
type: str
provisioning_fingerprint:
description:
- 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.
- Returned for get operation
returned: on success
sample: provisioning_fingerprint_example
type: str
provisioning_pin:
description:
- 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).
- Returned for get operation
returned: on success
sample: provisioning_pin_example
type: str
short_name:
description:
- 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.
returned: on success
sample: short_name_example
type: str
subnet_id:
description:
- L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
for the network subnet that is used to communicate with Compute Cloud@Customer
infrastructure.
returned: on success
sample: ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
type: str
system_tags:
description:
- 'System tags for this resource. Each key is predefined and scoped to a namespace.
Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`'
returned: on success
sample: {}
type: dict
time_created:
description:
- Compute Cloud@Customer infrastructure creation date and time, using an RFC3339
formatted datetime string.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_updated:
description:
- Compute Cloud@Customer infrastructure updated date and time, using an RFC3339
formatted datetime string.
- Returned for get operation
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
upgrade_information:
contains:
current_version:
description:
- The current version of software installed on the Compute Cloud@Customer
infrastructure.
returned: on success
sample: current_version_example
type: str
is_active:
description:
- Indication that the Compute Cloud@Customer infrastructure is in the process
of an upgrade or an upgrade activity (such as preloading upgrade images).
returned: on success
sample: true
type: bool
scheduled_upgrade_duration:
description:
- 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.
returned: on success
sample: scheduled_upgrade_duration_example
type: str
time_of_scheduled_upgrade:
description:
- Compute Cloud@Customer infrastructure next upgrade time. The rack might
have performance impacts during this time.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- ''
- Returned for get operation
returned: on success
type: complex
description:
- List of CccInfrastructure resources
returned: on success
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'
type: complex