cyberark.pas.cyberark_account модуль — Модуль для создания, удаления и изменения объектов CyberArk Account с использованием PAS Web Services SDK.

Примечание

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

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

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

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

Новое в cyberark.pas 1.0.0

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

Описание

Создаёт URI для добавления, удаления, изменения привилегированного идентификатора доступа в хранилище Cyberark Vault. Запрос использует SDK Web-служб безопасности привилегированных учетных записей.

Параметры

Параметр	Комментарии
address строка	Адрес конечной точки, где расположен привилегированный учётная запись.
api_base_url строка	Строка, содержащая базовый URL-адрес сервера, на котором размещается веб-службы CyberArk Privileged Account Security SDK. Пример https://<IIS_Server_Ip>/PasswordVault/api/
cyberark_session словарь / обязательный	Словарь, заданный авторизацией CyberArk, содержащий различные значения для выполнения действий в сессии CyberArk, пожалуйста, обратитесь к модулю cyberark.pas.cyberark_authentication для примера cyberark_session.
identified_by строка	При обращении к API для получения учетных записей часто заданные параметры идентифицируют более одной учетной записи. Этот параметр используется для уверенной идентификации одной учетной записи, когда стандартный запрос может возвращать несколько результатов. По умолчанию: `"username,address,platform_id"`
logging_file строка	Указание имени и расположения файла журнала для отладки. По умолчанию: `"/tmp/ansible_cyberark.log"`
logging_level строка	Параметр, используемый для определения уровня выходных данных отладки в `logging_file` значение. Варианты: `"NOTSET"` `"DEBUG"` `"INFO"`
name строка	ObjectID учетной записи
new_secret строка	Новый секрет/пароль, который будет сохранён в хранилище CyberArk.
platform_account_properties словарь	Объект, содержащий пары ключ-значение, которые необходимо связать с учетной записью, как определено платформой. Эти свойства проверяются на соответствие обязательным и необязательным свойствам указанного определения платформы. Необязательные свойства, которых нет в учетной записи, здесь не будут возвращены. Внутренние свойства не возвращаются.
Ключ псевдонимы: Порт, ExtrPass1Name, база данных строка	Произвольное значение ключа, связанное с обязательным или необязательным свойством, назначенным в определении указанной платформы.
platform_id строка	PolicyID платформы, которая будет управлять учетной записью
remote_machines_access словарь	Набор параметров для определения целевых объектов доступа PSM.
access_restricted_to_remote_machines логическое	Ограничить доступ только к указанным удалённым машинам. Варианты: `false` `true`
remote_machines строка	Список разрешённых целей для этой учетной записи.
safe строка / обязательный	Хранилище в Vault, где должна располагаться привилегированная учетная запись.
secret строка	Начальный пароль для создания учетной записи
secret_management словарь	Набор параметров, связанных с управлением учетными данными.
automatic_management_enabled логическое	Параметр, указывающий, будет ли CPM управлять паролем. Варианты: `false` ← (по умолчанию) `true`
management_action строка	Флаг действия CPM, который будет помещён на объект учетной записи для вращения учетных данных. Варианты: `"change"` `"change_immediately"` `"reconcile"`
manual_management_reason строка	Строковое значение, указывающее причину, по которой CPM НЕ будет управлять паролем.

new_secret string	Фактическое значение пароля, которое будет назначено для выполнения действия CPM.
perform_management_action string	`always` будет выполнять действие управления в каждом действии. `on_create` будет выполнять действие управления только сразу после создания учетной записи. Варианты: `"always"` ← (по умолчанию) `"on_create"`
secret_type string	Значение, определяющее тип учетной записи. Варианты: `"password"` ← (по умолчанию) `"key"`
state string	Установите желаемое состояние учетной записи `present` для создания или обновления объекта учетной записи. Установите значение `absent` для удаления объекта учетной записи. Варианты: `"present"` ← (по умолчанию) `"absent"`
username string	Имя пользователя, связанное с учетной записью.
validate_certs boolean	Если `false`, цепочка сертификатов SSL не будет валидирована. Это следует устанавливать в `true` только в том случае, если сертификат корневого центра выдачи сертификатов установлен на каждом узле. Варианты: `false` `true` ← (по умолчанию)

Примеры

collections:
  - cyberark.pas

tasks:

  - name: Logon to CyberArk Vault using PAS Web Services SDK
    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_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
        bechanged to.
    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: Logoff from CyberArk Vault
    cyberark_authentication:
      state: absent
      cyberark_session: "{{ cyberark_session }}"

Значения возврата

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

Ключ	Описание
changed boolean	Указывает, привело ли выполнение книги задач к каким-либо изменениям в учетной записи. Возвращается: всегда
failed boolean	Указывает, привело ли выполнение книги задач к ошибкам любого рода. Возвращается: всегда
result complex	JSON-представление результата действия. Возвращается: успех
address string	Адрес конечной точки, где расположена учетная запись с привилегиями. Возвращается: при успешном добавлении и модификации Пример: `"dev.local"`
createdTime integer	Вычисление временной отметки создания учетной записи. Возвращается: при успешном добавлении и модификации Пример: `1567824520`
id integer	Внутренний идентификатор объекта учетной записи. Возвращается: при успешном добавлении и модификации Пример: `2521`
name string	Внешний идентификатор объекта учетной записи. Возвращается: при успешном добавлении и модификации Пример: `"['Operating System-WinServerLocal-cyberark.local-administrator']"`
platformAccountProperties complex	Объект, содержащий пары «ключ-значение», связанные с учетной записью, определённые платформой учетной записи. Возвращается: при успешном добавлении и модификации
KEY VALUE string	Объект, содержащий пары «ключ-значение», связанные с учетной записью, определённые платформой учетной записи. Возвращается: при успешном добавлении и модификации Пример: `"[{'LogonDomain': 'cyberark'}, {'Port': '22'}]"`
platformId string	Идентификатор политики платформы, управляющей учетной записью. Возвращается: при успешном добавлении и модификации Пример: `"WinServerLocal"`
safeName string	Хранилище в хранилище Vault, где расположена учетная запись с привилегиями. Возвращается: при успешном добавлении и модификации Пример: `"Domain_Admins"`
secretManagement complex	Набор параметров, связанных с управлением учетными данными. Возвращается: при успешном добавлении и модификации
automaticManagementEnabled boolean	Параметр, указывающий, будет ли CPM управлять паролем. Возвращается: при успешном добавлении и модификации
lastModifiedTime integer	Вычисление временной отметки последнего изменения учетной записи. Возвращается: при успешном добавлении и модификации Пример: `1567824520`
manualManagementReason string	Причина отключения автоматического управления учетной записью Возвращается: если `automaticManagementEnabled` установлено в false Пример: `"This is a static account"`
secretType list / elements=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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cyberark/pas/cyberark_account_module.html