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

Примечание

Этот плагин является частью коллекции cyberark.pas (версия 1.0.5).

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

Для использования в книге задач укажите: cyberark.pas.cyberark_account.

Новое в версии 2.4: модуля cyberark.pas

Обзор
Параметры
Примеры
Значения возврата

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
address строка			Адрес конечной точки, где находится привилегированная учетная запись.
api_base_url строка / обязательно			Строка, содержащая базовый URL-адрес сервера, на котором размещен CyberArk's Privileged Account Security Web Services SDK. Пример https://<IIS_Server_Ip>/PasswordVault/api/
cyberark_session словарь / обязательно			Словарь, устанавливаемый после аутентификации в CyberArk, содержащий различные значения для выполнения действий в сессии CyberArk. Для примера cyberark_session обратитесь к модулю cyberark_authentication.
identified_by строка		По умолчанию: "username,address,platform_id"	При обращении к API для получения учетных записей параметры по умолчанию часто идентифицируют более одной учетной записи. Этот параметр используется для уверенной идентификации одной учетной записи, когда стандартный запрос может возвращать несколько результатов.
logging_file строка		По умолчанию: "/tmp/ansible_cyberark.log"	Указание имени и расположения файла журнала для отладки.
logging_level строка / обязательно		Варианты: NOTSET DEBUG INFO	Параметр, используемый для определения уровня вывода отладочной информации в значение `logging_file`.
name строка			ObjectID учетной записи
new_secret строка			Новое секретное значение/пароль, который будет сохранён в хранилище CyberArk Vault.
platform_account_properties словарь			Объект, содержащий пары ключ-значение для привязки к учетной записи, как определено платформой. Эти свойства проверяются на соответствие обязательным и необязательным свойствам, определенным для данной платформы. Необязательные свойства, отсутствующие в учетной записи, здесь не будут возвращены. Внутренние свойства не возвращаются.
	KEY строка		Произвольное значение ключа, связанное с обязательным или необязательным свойством, заданным для определения указанной платформы. алиасы: Port, ExtrPass1Name, database
platform_id строка			PolicyID платформы, которая управляет учетной записью
remote_machines_access словарь			Набор параметров для определения целевых объектов доступа к PSM-конечной точке.
	access_restricted_to_remote_machines логическое	Варианты: no yes	Ограничить доступ только к указанным удалённым машинам.
	remote_machines строка		Список разрешённых целевых объектов для этой учетной записи.
safe строка / обязательно			Хранилище Vault, в котором должна располагаться привилегированная учетная запись.
secret строка			Исходный пароль для создания учетной записи.
secret_management словарь			Набор параметров, связанных с управлением учетными данными.
	automatic_management_enabled логическое	Варианты: no ← yes	Указывает, будет ли CPM управлять паролем.
	management_action строка	Варианты: change change_immediately reconcile	Флаг действия CPM для помещения в объект учетной записи для вращения пароля.
	manual_management_reason строка		Строковое значение, указывающее причину, по которой CPM НЕ будет управлять паролем.
	new_secret строка		Фактическое значение пароля, которое будет присвоено для выполнения действия CPM.
	perform_management_action строка	Варианты: always ← on_create	`always` выполнит действие управления в каждом действии. `on_create` выполнит действие управления только после создания учетной записи.
secret_type строка		Варианты: password ← key	Значение, определяющее тип учетной записи.
state строка / обязательно		Варианты: present ← absent	Утверждение требуемого состояния учетной записи `present` для создания или обновления объекта учетной записи. Установите в `absent` для удаления объекта учетной записи.
username строка			Имя пользователя, связанное с учетной записью.
validate_certs логическое		Варианты: no yes ←	Если `false`, цепочка сертификатов SSL не будет проверена. Это следует установить только в `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: no
      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		успешное добавление и изменение	Внутренний идентификатор объекта для идентифицированной учетной записи. Пример: 25_21
	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': {'description': ['Параметр, указывающий, будет ли CPM управлять паролем.'], 'returned': 'успешное добавление и изменение', 'type': 'bool'}, 'lastModifiedTime': {'description': ['Время изменения учетной записи.'], 'returned': 'успешное добавление и изменение', 'sample': '1567824520', 'type': 'int'}, 'manualManagementReason': {'description': None, 'returned': 'если `automaticManagementEnabled` установлено в false', 'sample': 'Это статическая учетная запись', 'type': 'str'}}
	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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cyberark/pas/cyberark_account_module.html