oci_swift_password_facts - Retrieve details of swift passwords for a specified user

New in version 2.5.

Synopsis

  • This module retrieves details of swift passwords of a specified user. The returned object contains the swift password’s OCID, but not the password itself. The actual password is returned only upon creation of a swift password using the oci_swift_password module.

Requirements

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

Parameters

Parameter Choices/Defaults Comments
api_user
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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
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
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
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_type
    Choices:
  • api_key ←
  • instance_principal
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.
config_file_location
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 Default:
DEFAULT
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.
region
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.
swift_password_id
The OCID of the swift password. Required when facts about a specific swift password for the specified user needs to be obtained.

aliases: id
tenancy
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
user_id
required
The OCID of the user

Examples

- name: Get details of all the swift passwords of the specified user
  oci_swift_password_facts:
    user_id: "ocid1.user.oc1..xxxxxEXAMPLExxxxx"

- name: Get details of a specific swift password of a user
  oci_swift_password_facts:
    user_id: "ocid1.user.oc1..xxxxxEXAMPLExxxxx"
    id: "ocid1.credential.oc1..xxxxxEXAMPLExxxxx"

Return Values

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

Key Returned Description
swift_passwords
complex
 on success
Information about one or more swift passwords in the specified user

Sample:
{'swift_passwords': [{'lifecycle_state': 'ACTIVE', 'inactive_status': None, 'user_id': 'ocid1.user.oc1..xxxxxEXAMPLExxxxx', 'description': 'My first swift password description', 'time_created': '2018-01-03T13:15:53.082000+00:00', 'password': None, 'id': 'ocid1.credential.oc1..xxxxxEXAMPLExxxxx', 'expires_on': None}]}
  lifecycle_state
string
 always
The password's current state.

Sample:
ACTIVE
  inactive_status
string
 only when the lifecycle_state is 'INACTIVE'
The detailed status of INACTIVE lifecycleState.
  user_id
string
 always
The OCID of the user the password belongs to.

Sample:
ocid1.user.oc1..xxxxxEXAMPLExxxxx
  description
string
 always
The description that was assigned to the Swift password.

Sample:
My first swift password description
  id
string
 always
The OCID of the Swift password.

Sample:
ocid1.credential.oc1..xxxxxEXAMPLExxxxx
  time_created
string
 always
Date and time the SwiftPassword object was created, in the format defined by RFC3339.

Sample:
2016-08-25 21:10:29.600000
  expires_on
string
 always
Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires.

Sample:
2016-08-25 21:10:29.600000


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

  • Sivakumar Thyagarajan (@sivakumart)

Hint

If you notice any issues in this documentation you can edit this document to improve it.