purestorage.flasharray.purefa_apiclient – Управление клиентами API FlashArray
Примечание
Этот плагин входит в состав коллекции purestorage.flasharray (версия 1.5.1).
Для его установки используйте: ansible-galaxy collection install purestorage.flasharray.
Для использования в книге задач укажите: purestorage.flasharray.purefa_apiclient.
Новое в версии 1.5.0: purestorage.flasharray
Обзор
- Включение или выключение клиентов API FlashArray
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- purestorage >= 1.19
- py-pure-client >= 1.6.0
- netaddr
- requests
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_token строка | Токен API FlashArray для пользователя с правами администратора. | |
| enabled логическое значение |
| Состояние ключа API-клиента |
| fa_url строка | Управляющий IPv4-адрес или имя хоста FlashArray. | |
| issuer строка | Название поставщика удостоверений, который будет выдавать токены идентификации для этого API-клиента Если не указано, по умолчанию используется имя API-клиента, name. | |
| name строка / обязательно | Имя API-клиента | |
| public_key строка | Открытый ключ API-клиента в формате PEM (в кодировке Base64). Включайте строки —–BEGIN PUBLIC KEY—– и —–END PUBLIC KEY—– | |
| role строка |
| Максимальная роль, разрешенная для токенов идентификации, выданных этим API-клиентом |
| state строка |
| Определяет, должен ли существовать API-клиент или нет. |
| token_ttl целое число | По умолчанию: 86400 | Срок действия обменного токена доступа в секундах Диапазон от 1 секунды до 1 дня (86400 секунд) |
Примечания
Примечание
- Для работы этого модуля требуется библиотека Python
purestorage - Необходимо установить переменные среды
PUREFA_URLиPUREFA_API, если аргументы fa_url и api_token не переданы в модуль напрямую
Примеры
- name: Create API token ansible-token
purefa_apiclient:
name: ansible-token
issuer: "Pure Storage"
ttl: 3000
role: array_admin
public_key: "{{lookup('file', 'public_pem_file') }}"
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Disable API CLient
purefa_apiclient:
name: ansible-token
enabled: false
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Enable API CLient
purefa_apiclient:
name: ansible-token
enabled: true
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
- name: Delete API Client
purefa_apiclient:
state: absent
name: ansible-token
fa_url: 10.10.10.2
api_token: e31060a7-21fc-e277-6240-25983c6c4592
