oracle.oci.oci_file_storage_mount_target_actions – Perform actions on a MountTarget 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_file_storage_mount_target_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a MountTarget resource in Oracle Cloud Infrastructure

  • For action=change_compartment, moves a mount target and its associated export set or share set into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment

  • For action=validate_key_tabs, validates keytab contents for the secret details passed on the request or validte keytab contents associated with the mount target passed in the request. The keytabs are deserialized, the contents are validated for compatibility and the principal, key version number and encryption type of each entry is provided as part of the response.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • change_compartment
  • validate_key_tabs
The action to perform on the MountTarget.
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.
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 mount target to.
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.
key_tab_secret_details
dictionary
Applicable only for action=validate_key_tabs.
backup_key_tab_secret_version
integer
Version of the keytab secret in the Vault to use as a backup.
current_key_tab_secret_version
integer / required
Version of the keytab secret in the Vault to use.
key_tab_secret_id
string / required
The OCID of the keytab secret in the Vault.
mount_target_id
string
The OCID of the mount target.
Required for action=change_compartment.
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.
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

Examples

- name: Perform action change_compartment on mount_target
  oci_file_storage_mount_target_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    mount_target_id: "ocid1.mounttarget.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

- name: Perform action validate_key_tabs on mount_target
  oci_file_storage_mount_target_actions:
    # required
    action: validate_key_tabs

    # optional
    mount_target_id: "ocid1.mounttarget.oc1..xxxxxxEXAMPLExxxxxx"
    key_tab_secret_details:
      # required
      key_tab_secret_id: "ocid1.keytabsecret.oc1..xxxxxxEXAMPLExxxxxx"
      current_key_tab_secret_version: 56

      # optional
      backup_key_tab_secret_version: 56

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
mount_target
complex
on success
Details of the MountTarget resource acted upon by the current operation

Sample:
{'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'export_set_id': 'ocid1.exportset.oc1..xxxxxxEXAMPLExxxxxx', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'idmap_type': 'LDAP', 'kerberos': {'backup_key_tab_secret_version': 56, 'current_key_tab_secret_version': 56, 'is_kerberos_enabled': True, 'kerberos_realm': 'kerberos_realm_example', 'key_tab_secret_id': 'ocid1.keytabsecret.oc1..xxxxxxEXAMPLExxxxxx'}, 'ldap_idmap': {'cache_lifetime_seconds': 56, 'cache_refresh_interval_seconds': 56, 'group_search_base': 'group_search_base_example', 'negative_cache_lifetime_seconds': 56, 'outbound_connector1_id': 'ocid1.outboundconnector1.oc1..xxxxxxEXAMPLExxxxxx', 'outbound_connector2_id': 'ocid1.outboundconnector2.oc1..xxxxxxEXAMPLExxxxxx', 'schema_type': 'RFC2307', 'user_search_base': 'user_search_base_example'}, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'nsg_ids': [], 'private_ip_ids': [], 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00'}
 
availability_domain
string
on success
The availability domain the mount target is in. May be unset as a blank or NULL value.
Example: `Uocm:PHX-AD-1`

Sample:
Uocm:PHX-AD-1
 
compartment_id
string
on success
The OCID of the compartment that contains the mount target.

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. It does not have to be unique, and it is changeable. Avoid entering confidential information.
Example: `My mount target`

Sample:
display_name_example
 
export_set_id
string
on success
The OCID of the associated export set. Controls what file systems will be exported through Network File System (NFS) protocol on this mount target.

Sample:
ocid1.exportset.oc1..xxxxxxEXAMPLExxxxxx
 
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 mount target.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
idmap_type
string
on success
The method used to map a Unix UID to secondary groups. If NONE, the mount target will not use the Unix UID for ID mapping.

Sample:
LDAP
 
kerberos
complex
on success

   
backup_key_tab_secret_version
integer
on success
Version of the keytab secert in the Vault to use as a backup.

Sample:
56
   
current_key_tab_secret_version
integer
on success
Version of the keytab secret in the Vault to use.

Sample:
56
   
is_kerberos_enabled
boolean
on success
Specifies whether to enable or disable Kerberos.

Sample:
True
   
kerberos_realm
string
on success
The Kerberos realm that the mount target will join.

Sample:
kerberos_realm_example
   
key_tab_secret_id
string
on success
The OCID of the keytab secret in the Vault.

Sample:
ocid1.keytabsecret.oc1..xxxxxxEXAMPLExxxxxx
 
ldap_idmap
complex
on success

   
cache_lifetime_seconds
integer
on success
The maximum amount of time the mount target is allowed to use a cached entry.

Sample:
56
   
cache_refresh_interval_seconds
integer
on success
The amount of time that the mount target should allow an entry to persist in its cache before attempting to refresh the entry.

Sample:
56
   
group_search_base
string
on success
All LDAP searches are recursive starting at this group.
Example: `CN=Group,DC=domain,DC=com`

Sample:
group_search_base_example
   
negative_cache_lifetime_seconds
integer
on success
The amount of time that a mount target will maintain information that a user is not found in the ID mapping configuration.

Sample:
56
   
outbound_connector1_id
string
on success
The OCID of the first connector to use to communicate with the LDAP server.

Sample:
ocid1.outboundconnector1.oc1..xxxxxxEXAMPLExxxxxx
   
outbound_connector2_id
string
on success
The OCID of the second connector to use to communicate with the LDAP server.

Sample:
ocid1.outboundconnector2.oc1..xxxxxxEXAMPLExxxxxx
   
schema_type
string
on success
Schema type of the LDAP account.

Sample:
RFC2307
   
user_search_base
string
on success
All LDAP searches are recursive starting at this user.
Example: `CN=User,DC=domain,DC=com`

Sample:
user_search_base_example
 
lifecycle_details
string
on success
Additional information about the current 'lifecycleState'.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the mount target.

Sample:
CREATING
 
nsg_ids
list / elements=string
on success
A list of Network Security Group OCIDs associated with this mount target. A maximum of 5 is allowed. Setting this to an empty array after the list is created removes the mount target from all NSGs. For more information about NSGs, see Security Rules.
 
private_ip_ids
list / elements=string
on success
The OCIDs of the private IP addresses associated with this mount target.
 
subnet_id
string
on success
The OCID of the subnet the mount target is in.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The date and time the mount target was created, expressed in RFC 3339 timestamp format.
Example: `2016-08-25T21:10:29.600Z`

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


Authors

  • Oracle (@oracle)