Модуль cyberark.pas.cyberark_account — модуль для создания, удаления и изменения объектов учетных записей CyberArk, а также получения паролей с помощью PAS Web Services SDK.

Примечание

Этот модуль входит в коллекцию cyberark.pas (версия 1.0.39).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cyberark.pas.

Чтобы использовать коллекцию в плейбуке, укажите: cyberark.pas.cyberark_account.

Добавлено в cyberark.pas 1.0.0

Краткое описание
Параметры
Примеры
Возвращаемые значения

Краткое описание

Создает URI для добавления, удаления и изменения привилегированных учетных данных, а также для их получения из хранилища CyberArk. Запрос использует Privileged Account Security Web Services SDK.

Параметры

Параметр	Комментарии
address string	Адрес конечной точки, где находится привилегированная учетная запись.
api_base_url string	Строка с базовым URL-адресом сервера, на котором размещен CyberArk Privileged Account Security Web Services SDK. Пример https://<IIS_Server_Ip>/PasswordVault/api/
cyberark_session dictionary / обязательный	Словарь, формируемый при аутентификации в CyberArk и содержащий значения для выполнения действий в авторизованном сеансе CyberArk. Пример cyberark_session см. в модуле cyberark.pas.cyberark_authentication.
identified_by string	При вызове API Get Accounts часто передаваемые параметры по умолчанию идентифицируют несколько учетных записей. Этот параметр используется для однозначной идентификации одной учетной записи, если запрос с параметрами по умолчанию может вернуть несколько результатов. По умолчанию: `"username,address,platform_id"`
logging_file string	Имя и расположение файла журнала для устранения неполадок. По умолчанию: `"/tmp/ansible_cyberark.log"`
logging_level string	Параметр, задающий уровень вывода диагностической информации в значение `logging_file`. Варианты: `"NOTSET"` `"DEBUG"` `"INFO"`
name string	ObjectID учетной записи
new_secret string	Новый секрет/пароль, который будет сохранен в хранилище CyberArk.
platform_account_properties dictionary	Объект, содержащий пары «ключ-значение», связанные с учетной записью согласно определениям платформы учетной записи. Эти свойства проверяются на соответствие обязательным и необязательным свойствам указанного определения платформы. Необязательные свойства, отсутствующие в учетной записи, здесь не возвращаются. Внутренние свойства не возвращаются.
KEY псевдонимы: Port, ExtrPass1Name, database string	Произвольное значение ключа, связанное с обязательным или необязательным свойством, назначенным в определении указанной платформы.
platform_id string	PolicyID платформы, которая будет управлять учетной записью
remote_machines_access dictionary	Набор параметров для определения целевых объектов доступа к конечным точкам PSM.
access_restricted_to_remote_machines boolean	Ограничивать ли доступ только указанными удаленными компьютерами. Варианты: `false` `true`
remote_machines string	Список целевых объектов, разрешенных для этой учетной записи.
safe string / обязательный	Safe в хранилище, где должна находиться привилегированная учетная запись.
secret string	Начальный пароль для создания учетной записи
secret_management dictionary	Набор параметров, связанных с управлением учетными данными.
automatic_management_enabled boolean	Параметр, указывающий, будет ли CPM управлять паролем. Варианты: `false` ← (по умолчанию) `true`
management_action string	Флаг действия CPM, который будет установлен для объекта учетной записи при смене учетных данных. Варианты: `"change"` `"change_immediately"` `"reconcile"`
manual_management_reason string	Строковое значение, указывающее, почему CPM НЕ будет управлять паролем.
new_secret string	Фактическое значение пароля, которое будет назначено при выполнении действия CPM.
perform_management_action string	`always` будет выполнять действие управления при каждом действии. `on_create` будет выполнять действие управления только сразу после создания учетной записи. Варианты: `"always"` ← (по умолчанию) `"on_create"`
secret_type string	Значение, определяющее тип учетной записи. Варианты: `"password"` ← (по умолчанию) `"key"`
state string	Задает желаемое состояние учетной записи: `present` — для создания или обновления объекта учетной записи. Укажите `absent` для удаления объекта учетной записи. Укажите `retrieve`, чтобы получить объект учетной записи, включая пароль. Варианты: `"present"` ← (по умолчанию) `"absent"` `"retrieve"`
username string	Имя пользователя, связанное с учетной записью.
validate_certs boolean	Если задано `false`, цепочка SSL-сертификатов не будет проверяться. Значение `true` следует указывать только в том случае, если на каждом узле установлен корневой сертификат CA. Варианты: `false` `true` ← (по умолчанию)

Примеры

- name: Logon to CyberArk Vault using PAS Web Services SDK
  cyberark.pas.cyberark_authentication:
    api_base_url: "http://components.cyberark.local"
    validate_certs: false
    username: "bizdev"
    password: "Cyberark1"

- name: Creating an Account using the PAS WebServices SDK
  cyberark.pas.cyberark_account:
    logging_level: DEBUG
    identified_by: "address,username"
    safe: "Test"
    address: "cyberark.local"
    username: "administrator-x"
    platform_id: WinServerLocal
    secret: "@N&Ibl3!"
    platform_account_properties:
      LogonDomain: "cyberark"
      OwnerName: "ansible_user"
    secret_management:
      automatic_management_enabled: true
    state: present
    cyberark_session: "{{ cyberark_session }}"
    register: cyberarkaction

- name: Rotate credential via reconcile and providing the password to be changed to
  cyberark.pas.cyberark_account:
    identified_by: "address,username"
    safe: "Domain_Admins"
    address: "prod.cyberark.local"
    username: "admin"
    platform_id: WinDomain
    platform_account_properties:
      LogonDomain: "PROD"
    secret_management:
      new_secret: "Ama123ah12@#!Xaamdjbdkl@#112"
      management_action: "reconcile"
      automatic_management_enabled: true
    state: present
    cyberark_session: "{{ cyberark_session }}"
    register: reconcileaccount

- name: Update password only in VAULT
  cyberark.pas.cyberark_account:
    identified_by: "address,username"
    safe: "Domain_Admins"
    address: "prod.cyberark.local"
    username: "admin"
    platform_id: Generic
    new_secret: "Ama123ah12@#!Xaamdjbdkl@#112"
    state: present
    cyberark_session: "{{ cyberark_session }}"
    register: updateaccount

- name: Retrieve account and password
  cyberark.pas.cyberark_account:
    identified_by: "address,username"
    safe: "Domain_Admins"
    address: "prod.cyberark.local"
    username: "admin"
    state: retrieve
    cyberark_session: "{{ cyberark_session }}"
    register: retrieveaccount

- name: Logoff from CyberArk Vault
  cyberark.pas.cyberark_authentication:
    state: absent
    cyberark_session: "{{ cyberark_session }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
changed boolean	Показывает, привел ли запуск плейбука к каким-либо изменениям учетной записи. Возвращается: всегда
failed boolean	Показывает, завершился ли запуск плейбука с ошибкой любого рода. Возвращается: всегда
result complex	Результат выполненного действия в формате JSON. Возвращается: при успешном выполнении
address string	Адрес конечной точки, где находится привилегированная учетная запись. Возвращается: при успешном добавлении и изменении Пример: `"dev.local"`
createdTime integer	Временная метка создания учетной записи. Возвращается: при успешном добавлении и изменении Пример: `1567824520`
id integer	Внутренний ObjectID указанного объекта учетной записи Возвращается: при успешном добавлении и изменении Пример: `2521`
name string	Внешний ObjectID учетной записи Возвращается: при успешном добавлении и изменении Пример: `"['Operating System-WinServerLocal-cyberark.local-administrator']"`
platformAccountProperties complex	Объект, содержащий пары «ключ-значение», связанные с учетной записью согласно определениям платформы учетной записи. Возвращается: при успешном добавлении и изменении
KEY VALUE string	Объект, содержащий пары «ключ-значение», связанные с учетной записью согласно определениям платформы учетной записи. Возвращается: при успешном добавлении и изменении Пример: `"[{'LogonDomain': 'cyberark'}, {'Port': '22'}]"`
platformId string	PolicyID платформы, которая будет управлять учетной записью. Возвращается: при успешном добавлении и изменении Пример: `"WinServerLocal"`
safeName string	Safe в хранилище, где должна находиться привилегированная учетная запись. Возвращается: при успешном добавлении и изменении Пример: `"Domain_Admins"`
secretManagement complex	Набор параметров, связанных с управлением учетными данными. Возвращается: при успешном добавлении и изменении
automaticManagementEnabled boolean	Параметр, указывающий, будет ли CPM управлять паролем. Возвращается: при успешном добавлении и изменении
lastModifiedTime integer	Временная метка изменения учетной записи. Возвращается: при успешном добавлении и изменении Пример: `1567824520`
manualManagementReason string	Причина отключения автоматического управления учетной записью Возвращается: если для `automaticManagementEnabled` задано значение false Пример: `"This is a static account"`
secretType list / элементы=string	Значение, определяющее тип учетной записи Возвращается: при успешном добавлении и изменении Пример: `["key", "password"]`
userName string	Имя пользователя, связанное с учетной записью Возвращается: при успешном добавлении и изменении Пример: `"administrator"`
status_code integer	Код состояния HTTP, возвращенный в результате. Возвращается: при успешном выполнении Пример: `"200, 201, -1, 204"`

Авторы

CyberArk BizDev (@cyberark-bizdev)
Edward Nunez (@enunez-cyberark)
James Stutes (@jimmyjamcabd)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cyberark/pas/cyberark_account_module.html