Модуль purestorage.flasharray.purefa_apiclient – Управление клиентами API FlashArray

Примечание

Этот модуль является частью коллекции purestorage.flasharray (версия 1.31.1).

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

Для установки используйте: ansible-galaxy collection install purestorage.flasharray. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

Для использования в playbook, укажите: purestorage.flasharray.purefa_apiclient.

Новое в purestorage.flasharray 1.5.0

Краткое описание
Требования
Параметры
Примечания
Примеры

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

Включение или отключение клиентов API FlashArray

Требования

Ниже указаны требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 3.3
purestorage >= 1.19
py-pure-client >= 1.26.0
netaddr
requests
pycountry
urllib3

Параметры

Параметр	Комментарии
api_token строка	Маркер API FlashArray для пользователя с правами администратора.
disable_warnings булево добавлено в purestorage.flasharray 1.29.0	Отключить предупреждения о небезопасных сертификатах в журналах отладки Варианты: `false` ← (по умолчанию) `true`
enabled булево	Состояние ключа API Client Варианты: `false` `true` ← (по умолчанию)
fa_url строка	IP-адрес управления FlashArray IPv4 или имя хоста.
issuer строка	Имя поставщика удостоверений, который будет выдавать токены ID для этого клиента API Если не указано, используется имя клиента API, name.
name строка / обязательно	Имя клиента API
public_key строка	Открытый ключ RSA клиента API в формате PEM (кодировка Base64). Включите строки —–BEGIN PUBLIC KEY—– и —–END PUBLIC KEY—–
role строка	Максимальная роль, разрешенная для токенов ID, выданных этим клиентом API Варианты: `"readonly"` `"ops_admin"` `"storage_admin"` `"array_admin"`
state строка	Определяет, должен ли существовать клиент API или нет. Варианты: `"absent"` `"present"` ← (по умолчанию)
token_ttl целое число	Время существования (TTL) в секундах для обмененного токена доступа Диапазон от 1 секунды до 1 дня (86400 секунд) По умолчанию: `86400`

Примечания

Примечание

Этот модуль требует библиотек Python purestorage и py-pure-client
Для определенных модулей могут потребоваться дополнительные библиотеки Python.
Вы должны установить переменные среды PUREFA_URL и PUREFA_API, если аргументы fa_url и api_token не передаются в модуль напрямую

Примеры

- name: Create API token ansible-token
  purestorage.flasharray.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
  purestorage.flasharray.purefa_apiclient:
    name: ansible-token
    enabled: false
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Enable API CLient
  purestorage.flasharray.purefa_apiclient:
    name: ansible-token
    enabled: true
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

- name: Delete API Client
  purestorage.flasharray.purefa_apiclient:
    state: absent
    name: ansible-token
    fa_url: 10.10.10.2
    api_token: e31060a7-21fc-e277-6240-25983c6c4592

Авторы

Команда Pure Storage Ansible (@sdodsley)

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

© 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/purestorage/flasharray/purefa_apiclient_module.html