oracle.oci.oci_os_management_hub_profile_actions – Perform actions on a Profile resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.5.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_os_management_hub_profile_actions.
New in version 2.9.0: of oracle.oci
Synopsis¶
Perform actions on a Profile resource in Oracle Cloud Infrastructure
For action=change_compartment, moves the profile to a different compartment.
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 |
|---|---|---|
|
action
string
/ required
|
|
The action to perform on the Profile.
|
|
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.
|
|
|
compartment_id
string
|
The OCID of the compartment to move the profile to.
|
|
|
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. |
|
|
profile_id
string
/ required
|
The OCID of the registration profile.
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: Perform action change_compartment on profile
oci_os_management_hub_profile_actions:
# required
profile_id: "ocid1.profile.oc1..xxxxxxEXAMPLExxxxxx"
action: change_compartment
# optional
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | ||
|---|---|---|---|---|
|
profile
complex
|
on success |
Details of the Profile resource acted upon by the current operation
Sample:
{'arch_type': 'X86_64', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_default_profile': True, 'is_service_provided_profile': True, 'lifecycle_environment': {'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}, 'lifecycle_stage': {'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}, 'lifecycle_state': 'CREATING', 'managed_instance_group': {'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}, 'management_station_id': 'ocid1.managementstation.oc1..xxxxxxEXAMPLExxxxxx', 'os_family': 'ORACLE_LINUX_9', 'profile_type': 'SOFTWARESOURCE', 'registration_type': 'OCI_LINUX', 'software_sources': [{'description': 'description_example', 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_mandatory_for_autonomous_linux': True, 'software_source_type': 'VENDOR'}], 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'vendor_name': 'ORACLE'}
|
||
|
arch_type
string
|
on success |
The architecture type.
Sample:
X86_64
|
||
|
compartment_id
string
|
on success |
The OCID of the compartment that contains the registration profile.
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'}}
|
||
|
description
string
|
on success |
The description of the registration profile.
Sample:
description_example
|
||
|
display_name
string
|
on success |
A user-friendly name for the profile.
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 registration profile.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
is_default_profile
boolean
|
on success |
Indicates if the profile is set as the default. There is exactly one default profile for a specified architecture, OS family, registration type, and vendor. When registering an instance with the corresonding characteristics, the default profile is used, unless another profile is specified.
Sample:
True
|
||
|
is_service_provided_profile
boolean
|
on success |
Indicates if the profile was created by the service. OS Management Hub provides a limited set of standardized profiles that can be used to register Autonomous Linux or Windows instances.
Sample:
True
|
||
|
lifecycle_environment
complex
|
on success |
|
||
|
display_name
string
|
on success |
Lifecycle environment name.
Sample:
display_name_example
|
||
|
id
string
|
on success |
The OCID of the lifecycle environment.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
lifecycle_stage
complex
|
on success |
|
||
|
display_name
string
|
on success |
Lifecycle stage name.
Sample:
display_name_example
|
||
|
id
string
|
on success |
The OCID of the lifecycle stage.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
lifecycle_state
string
|
on success |
The current state of the registration profile.
Sample:
CREATING
|
||
|
managed_instance_group
complex
|
on success |
|
||
|
display_name
string
|
on success |
Managed instance group name.
Sample:
display_name_example
|
||
|
id
string
|
on success |
The OCID of the managed instance group.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
management_station_id
string
|
on success |
The OCID of the management station to associate with an instance once registered. Associating with a management station applies only to non-OCI instances.
Sample:
ocid1.managementstation.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
os_family
string
|
on success |
The operating system family.
Sample:
ORACLE_LINUX_9
|
||
|
profile_type
string
|
on success |
The type of profile.
Sample:
SOFTWARESOURCE
|
||
|
registration_type
string
|
on success |
The type of instance to register.
Sample:
OCI_LINUX
|
||
|
software_sources
complex
|
on success |
The list of software sources that the registration profile will use.
|
||
|
description
string
|
on success |
Software source description.
Sample:
description_example
|
||
|
display_name
string
|
on success |
Software source name.
Sample:
display_name_example
|
||
|
id
string
|
on success |
The OCID of the software source.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
|
is_mandatory_for_autonomous_linux
boolean
|
on success |
Indicates whether this is a required software source for Autonomous Linux instances. If true, the user can't unselect it.
Sample:
True
|
||
|
software_source_type
string
|
on success |
Type of the software source.
Sample:
VENDOR
|
||
|
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 |
The time the registration profile was created (in RFC 3339 format).
Sample:
2013-10-20T19:20:30+01:00
|
||
|
vendor_name
string
|
on success |
The vendor of the operating system for the instance.
Sample:
ORACLE
|
||
Authors¶
Oracle (@oracle)