oracle.oci.oci_network_cpe_device_shape_facts – Fetches details about one or multiple CpeDeviceShape resources in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.1.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_cpe_device_shape_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple CpeDeviceShape resources in Oracle Cloud Infrastructure
Lists the CPE device types that the Networking service provides CPE configuration content for (example: Cisco ASA). The content helps a network engineer configure the actual CPE device represented by a Cpe object.
If you want to generate CPE configuration content for one of the returned CPE device types, ensure that the Cpe object’s cpeDeviceShapeId attribute is set to the CPE device type’s OCID (returned by this operation).
For information about generating CPE configuration content, see these operations:
If cpe_device_shape_id is specified, the details of a single CpeDeviceShape will be returned.
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. |
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.
|
|
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 . |
|
cpe_device_shape_id
string
|
The OCID of the CPE device shape.
Required to get a specific cpe_device_shape.
aliases: id |
|
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. |
|
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Get a specific cpe_device_shape
oci_network_cpe_device_shape_facts:
# required
cpe_device_shape_id: "ocid1.cpedeviceshape.oc1..xxxxxxEXAMPLExxxxxx"
- name: List cpe_device_shapes
oci_network_cpe_device_shape_facts:
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
cpe_device_shapes
complex
|
on success |
List of CpeDeviceShape resources
Sample:
[{'cpe_device_info': {'platform_software_version': 'platform_software_version_example', 'vendor': 'vendor_example'}, 'cpe_device_shape_id': 'ocid1.cpedeviceshape.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'parameters': [{'display_name': 'display_name_example', 'explanation': 'explanation_example', 'key': 'key_example'}], 'template': 'template_example'}]
|
||
cpe_device_info
complex
|
on success |
|
||
platform_software_version
string
|
on success |
The platform or software version of the CPE device.
Sample:
platform_software_version_example
|
||
vendor
string
|
on success |
The vendor that makes the CPE device.
Sample:
vendor_example
|
||
cpe_device_shape_id
string
|
on success |
The OCID of the CPE device shape. This value uniquely identifies the type of CPE device.
Returned for get operation
Sample:
ocid1.cpedeviceshape.oc1..xxxxxxEXAMPLExxxxxx
|
||
id
string
|
on success |
The OCID of the CPE device shape. This value uniquely identifies the type of CPE device.
Returned for list operation
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
parameters
complex
|
on success |
For certain CPE devices types, the customer can provide answers to questions that are specific to the device type. This attribute contains a list of those questions. The Networking service merges the answers with other information and renders a set of CPE configuration content. To provide the answers, use UpdateTunnelCpeDeviceConfig.
Returned for get operation
|
||
display_name
string
|
on success |
A descriptive label for the question (for example, to display in a form in a graphical interface). Avoid entering confidential information.
Sample:
display_name_example
|
||
explanation
string
|
on success |
A description or explanation of the question, to help the customer answer accurately.
Sample:
explanation_example
|
||
key
string
|
on success |
A string that identifies the question.
Sample:
key_example
|
||
template
string
|
on success |
A template of CPE device configuration information that will be merged with the customer's answers to the questions to render the final CPE device configuration content. Also see:
Returned for get operation
Sample:
template_example
|
Authors¶
Oracle (@oracle)