ipa_vault - Manage FreeIPA vaults

New in version 2.7.

Synopsis

Parameters

Parameter Choices/Defaults Comments
cn
required
Vault name.
Can not be changed as it is the unique identifier.

aliases: name
description
Description.
ipa_host Default:
ipa.example.com
IP or hostname of IPA server.
If the value is not specified in the task, the value of environment variable IPA_HOST will be used instead.
If both the environment variable IPA_HOST and the value are not specified in the task, then default value is set.
Environment variable fallback mechanism is added in version 2.5.
ipa_pass
required
Password of administrative user.
If the value is not specified in the task, the value of environment variable IPA_PASS will be used instead.
If both the environment variable IPA_PASS and the value are not specified in the task, then default value is set.
Environment variable fallback mechanism is added in version 2.5.
ipa_port Default:
443
Port of FreeIPA / IPA server.
If the value is not specified in the task, the value of environment variable IPA_PORT will be used instead.
If both the environment variable IPA_PORT and the value are not specified in the task, then default value is set.
Environment variable fallback mechanism is added in version 2.5.
ipa_prot
    Choices:
  • http
  • https ←
Protocol used by IPA server.
If the value is not specified in the task, the value of environment variable IPA_PROT will be used instead.
If both the environment variable IPA_PROT and the value are not specified in the task, then default value is set.
Environment variable fallback mechanism is added in version 2.5.
ipa_timeout
(added in 2.7)
Default:
10
Specifies idle timeout (in seconds) for the connection.
For bulk operations, you may want to increase this in order to avoid timeout from IPA server.
If the value is not specified in the task, the value of environment variable IPA_TIMEOUT will be used instead.
If both the environment variable IPA_TIMEOUT and the value are not specified in the task, then default value is set.
ipa_user Default:
admin
Administrative account used on IPA server.
If the value is not specified in the task, the value of environment variable IPA_USER will be used instead.
If both the environment variable IPA_USER and the value are not specified in the task, then default value is set.
Environment variable fallback mechanism is added in version 2.5.
ipavaultpublickey
Public key.

aliases: vault_public_key
ipavaultsalt
Vault Salt.

aliases: vault_salt
ipavaulttype
required
    Choices:
  • standard
  • symmetric ←
  • asymmetric
Vault types are based on security level.

aliases: vault_type
replace
bool
    Choices:
  • no ←
  • yes
Force replace the existant vault on IPA server.
service
Any service can own one or more service vaults.
Mutually exclusive with user.
state
    Choices:
  • present ←
  • absent
State to ensure.
username
Any user can own one or more user vaults.
Mutually exclusive with service.

aliases: user
validate_certs
bool
    Choices:
  • no
  • yes ←
Validate IPA server certificates.

Examples

# Ensure vault is present
- ipa_vault:
    name: vault01
    vault_type: standard
    user: user01
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret
    validate_certs: false

# Ensure vault is present for Admin user
- ipa_vault:
    name: vault01
    vault_type: standard
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

# Ensure vault is absent
- ipa_vault:
    name: vault01
    vault_type: standard
    user: user01
    state: absent
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

# Modify vault if already exists
- ipa_vault:
    name: vault01
    vault_type: standard
    description: "Vault for test"
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret
    replace: True

# Get vault info if already exists
- ipa_vault:
    name: vault01
    ipa_host: ipa.example.com
    ipa_user: admin
    ipa_pass: topsecret

Return Values

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

Key Returned Description
vault
dict
always
Vault as returned by IPA API



Status

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

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Juan Manuel Parrilla (@jparrill)

Hint

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