cyberark.pas.cyberark_account – Модуль для создания, удаления и изменения объекта учетной записи CyberArk с использованием PAS Web Services SDK.
Примечание
Этот плагин является частью коллекции cyberark.pas (версия 1.0.5).
Для его установки используйте: ansible-galaxy collection install cyberark.pas.
Для использования в книге задач укажите: cyberark.pas.cyberark_account.
Новое в версии 2.4: of cyberark.pas
Обзор
- Создаёт URI для добавления, удаления, изменения привилегированного учетной записи в хранилище CyberArk. Запрос использует SDK для веб-служб Privileged Account Security.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| address строка | Адрес конечной точки, где расположена привилегированная учетная запись. | ||
| api_base_url строка / обязательно | Строка, содержащая базовый URL-адрес сервера, на котором размещены веб-службы CyberArk Privileged Account Security SDK. | ||
| cyberark_session словарь / обязательно | Словарь, устанавливаемый CyberArk-аутентификацией, содержащий различные значения для выполнения действий с вошедшей в систему учетной записью CyberArk. Для примера cyberark_session см. модуль cyberark_authentication. | ||
| identified_by строка | По умолчанию: "username,address,platform_id" | При обращении к API для получения учетных записей параметры по умолчанию часто идентифицируют более одной учетной записи. Этот параметр используется для уверенной идентификации одной учетной записи, когда стандартный запрос может возвращать несколько результатов. | |
| logging_file строка | По умолчанию: "/tmp/ansible_cyberark.log" | Установка имени и расположения файла журнала для отладки. | |
| logging_level строка / обязательно |
| Параметр, используемый для определения уровня выходных данных отладки в значение 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 булево |
| Ограничивать ли доступ только к указанным удалённым машинам. | |
| remote_machines строка | Список разрешённых целей для этой учетной записи. | ||
| safe строка / обязательно | Хранилище в Vault, где должна быть расположена привилегированная учетная запись. | ||
| secret строка | Начальный пароль для создания учетной записи | ||
| secret_management словарь | Набор параметров, связанных с управлением учетной записью. | ||
| automatic_management_enabled булево |
| Указывает, будет ли CPM управлять паролем или нет. | |
| management_action строка |
| Флаг действия CPM, который будет помещен на объект учетной записи для вращения учетных данных. | |
| manual_management_reason строка | Строковое значение, указывающее причину, по которой CPM не будет управлять паролем. | ||
| new_secret строка | Фактическое значение пароля, которое будет назначено для выполнения действия CPM. | ||
| perform_management_action строка |
| always выполнит действие управления при каждом действии.on_create выполнит действие управления только сразу после создания учетной записи. | |
| secret_type строка |
| Значение, определяющее тип учетной записи. | |
| state строка / обязательно |
| Утверждение желаемого состояния учетной записи present для создания или обновления объекта учетной записи. Установите значение absent для удаления объекта учетной записи. | |
| username строка | Имя пользователя, связанное с учетной записью. | ||
| validate_certs булево |
| Если false, цепочка сертификатов SSL не будет проверена. Это должно быть установлено только в true, если у вас установлен сертификат корневого CA на каждом узле. | |
Примеры
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cyberark/pas/cyberark_account_module.html
