Spec-Zone.ru › Ansible

Модуль netapp.ontap.na_ontap_info — сборщик информации NetApp

Примечание

Этот модуль входит в коллекцию netapp.ontap (версия 23.5.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install netapp.ontap. Для работы с этим модулем необходимы дополнительные требования. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: netapp.ontap.na_ontap_info.

Добавлено в netapp.ontap 2.9.0

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

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

  • Этот модуль позволяет собирать различную информацию о конфигурации ONTAP.

Требования

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

  • Физическая или виртуальная кластерная система Data ONTAP. Модули поддерживают Data ONTAP 9.1 и более поздние версии; для работы REST требуется ONTAP 9.6 или более поздняя версия.
  • Ansible 2.9 или более поздняя версия — рекомендуется 2.12 или более поздняя.
  • Python3 — рекомендуется версия 3.9 или более поздняя.
  • netapp-lib требуется только при использовании ZAPI (установите с помощью «pip install netapp-lib»). Обратите внимание, что netapp-lib устарел и больше не поддерживается. Используйте на свой страх и риск.
  • netapp_lib

Параметры

Параметр

Комментарии

cert_filepath

строка

добавлено в netapp.ontap 20.6.0

Путь к файлу сертификата клиента SSL (.pem).

Не поддерживается в Python 2.6.

continue_on_error

список / элементы=строка

По умолчанию модуль завершается с ошибкой при первой же ошибке.

Этот параметр позволяет указать список ошибок, при возникновении которых модуль не завершится с ошибкой.

Ошибки из списка отображаются в выводе в соответствующем элементе info как запись «error».

Допустимые значения: always, never, missing_vserver_api_error, rpc_error, other_error.

missing_vserver_api_error — вероятнее всего, API доступен на уровне кластера, но не на уровне vserver.

rpc_error — некоторые запросы завершаются с ошибкой, поскольку узел не может связаться с другим узлом кластера.

key_error — запрос завершается с ошибкой, поскольку в возвращённых данных отсутствует ожидаемый ключ.

При возникновении ошибок ключей сообщите об этом в Discord. Возможно, это связано с изменениями в новой версии ONTAP.

other_error — любая ошибка, не входящая в приведённый выше список.

always позволяет продолжить работу при любой ошибке, а never приводит к завершению с ошибкой при любой ошибке; эти значения нельзя использовать с другими ключевыми словами.

По умолчанию: ["never"]

desired_attributes

словарь

добавлено в netapp.ontap 20.6.0

Дополнительная функция, для использования которой необходимо понимать внутреннее устройство ZAPI.

Позволяет запросить определённый атрибут, который не возвращается по умолчанию, или ограничить список возвращаемых атрибутов.

Словарь для элемента zapi desired-attributes.

Тег XML <tag>value</tag> представляется словарём, в котором tag — ключ.

Значением может быть другой словарь, список словарей, строка или пустое значение.

Например, <tag/> представляется как tag:

Если задан этот параметр, за один раз можно вызвать только одно подмножество.

Вызывающий код отвечает за то, чтобы ключевые атрибуты присутствовали в правильном месте.

Если какой-либо ключевой атрибут отсутствует, модуль завершится с ошибкой.

feature_flags

словарь

добавлено в netapp.ontap 20.5.0

Включение или отключение новой функции.

Можно использовать для включения экспериментальной функции или отключения новой функции, нарушающей обратную совместимость.

Поддерживаемые ключи и значения могут измениться без предварительного уведомления. Неизвестные ключи игнорируются.

gather_subset

список / элементы=строка

Если задан, этот аргумент ограничивает сбор информации указанным подмножеством. Возможные значения аргумента:

active_directory_account_info

aggregate_info

aggr_efficiency_info

autosupport_check_info

cifs_options_info

cifs_server_info

cifs_share_info

cifs_vserver_security_info

cluster_identity_info

cluster_image_info

cluster_log_forwarding_info

cluster_node_info

cluster_peer_info

cluster_switch_info

clock_info

disk_info

env_sensors_info

event_notification_destination_info

event_notification_info

export_policy_info

export_rule_info

fcp_adapter_info

fcp_alias_info

fcp_service_info

igroup_info

iscsi_service_info

job_schedule_cron_info

kerberos_realm_info

ldap_client

ldap_config

license_info

lun_info

lun_map_info

metrocluster_check_info

metrocluster_info

metrocluster_node_info

net_dev_discovery_info

net_dns_info

net_failover_group_info

net_firewall_info

net_ifgrp_info

net_interface_info

net_interface_service_policy_info

net_ipspaces_info

net_port_info

net_port_broadcast_domain_info

net_routes_info

net_vlan_info

nfs_info

ntfs_dacl_info

ntfs_sd_info

ntp_server_info

nvme_info

nvme_interface_info

nvme_namespace_info

nvme_subsystem_info

ontap_system_version

ontap_version

ontapi_version

qos_adaptive_policy_info

qos_policy_info

qtree_info

quota_policy_info

quota_report_info

role_info

security_key_manager_key_info

security_login_account_info

security_login_role_config_info

security_login_role_info

service_processor_info

service_processor_network_info

shelf_info

sis_info

sis_policy_info

snapmirror_info

snapmirror_destination_info

snapmirror_policy_info

snapshot_info

snapshot_policy_info

storage_failover_info

storage_bridge_info

subsys_health_info

sysconfig_info

sys_cluster_alerts

volume_info

volume_space_info

vscan_info

vscan_status_info

vscan_scanner_pool_info

vscan_connection_status_all_info

vscan_connection_extended_stats_info

vserver_info

vserver_login_banner_info

vserver_motd_info

vserver_nfs_info

vserver_peer_info

Можно указать список значений, чтобы включить большее подмножество.

Перед значениями также можно указать !, чтобы обозначить, что определённое подмножество не нужно собирать.

NVMe поддерживается начиная с ONTAP 9.4.

Используйте «help», чтобы получить список поддерживаемой информации для вашей системы.

Для lun_info значения serial_hex и naa_id вычисляются, если задан serial_number.

По умолчанию: ["all"]

hostname

строка / обязательный

Имя хоста или IP-адрес экземпляра ONTAP.

http_port

целое число

Использовать указанный порт вместо порта по умолчанию (80 или 443).

https

логическое значение

Включение и отключение HTTPS.

Игнорируется при использовании REST, поскольку поддерживается только HTTPS.

Игнорируется при использовании аутентификации по SSL-сертификату, так как для неё требуется SSL.

Варианты:

  • false ← (по умолчанию)
  • true

key_filepath

строка

добавлено в netapp.ontap 20.6.0

Путь к файлу ключа клиента SSL.

max_records

целое число

добавлено в netapp.ontap 20.2.0

Максимальное количество записей, возвращаемых одним вызовом ZAPI. Допустимый диапазон: [1..2^32-1]. Этот параметр управляет внутренним поведением модуля.

По умолчанию: 1024

ontapi

целое число

Версия API ONTAP, которую следует использовать.

password

псевдонимы: pass

строка

Пароль указанного пользователя.

query

словарь

добавлено в netapp.ontap 20.7.0

Дополнительная функция, для использования которой необходимо понимать внутреннее устройство ZAPI.

Позволяет указать, какие объекты следует вернуть.

Словарь для элемента zapi query.

Тег XML <tag>value</tag> представляется словарём, в котором tag — ключ.

Значением может быть другой словарь, список словарей, строка или пустое значение.

Например, <tag/> представляется как tag:

Если задан этот параметр, за один раз можно вызвать только одно подмножество.

state

строка

Устарел начиная с версии 21.1.0.

Этот параметр игнорировался и продолжает игнорироваться.

summary

логическое значение

добавлено в netapp.ontap 20.4.0

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

Если значение равно true, возвращаются только имена.

Варианты:

  • false ← (по умолчанию)
  • true

use_native_zapi_tags

логическое значение

добавлено в netapp.ontap 20.6.0

По умолчанию символ - в ключах возвращаемого словаря преобразуется в _.

Если задано значение true, преобразование отключается.

Варианты:

  • false ← (по умолчанию)
  • true

use_rest

строка

Этот модуль поддерживает только ZAPI; переключение на REST невозможно.

never — всегда использовать ZAPI, если модуль поддерживает ZAPI. Если параметр REST не поддерживается в ZAPI, может быть выдана ошибка.

auto — всегда использовать ZAPI.

По умолчанию: "never"

username

псевдонимы: user

строка

Это может быть учётная запись на уровне кластера или SVM — в зависимости от того, какой API требуется: на уровне кластера или SVM.

Дополнительные сведения см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html.

Поддерживаются два метода аутентификации:

  1. Обычная аутентификация с использованием имени пользователя и пароля.
  2. Аутентификация по SSL-сертификату с использованием файла сертификата клиента SSL и, при необходимости, файла закрытого ключа.

Для использования сертификата его необходимо установить в кластере ONTAP и включить аутентификацию по сертификату.

validate_certs

логическое значение

Если задано значение no, сертификаты SSL не проверяются.

Задавайте это значение только для False на сайтах под личным контролем, использующих самоподписанные сертификаты.

Варианты:

  • false
  • true ← (по умолчанию)

volume_move_target_aggr_info

словарь

добавлено в netapp.ontap 20.5.0

Обязательные параметры для volume_move_target_aggr_info.

volume_name

строка / обязательный

добавлено в netapp.ontap 20.5.0

Имя тома, для которого нужно получить сведения о целевом агрегате.

vserver

строка / обязательный

добавлено в netapp.ontap 20.5.0

Vserver, на котором находится том.

vserver

строка

добавлено в netapp.ontap 19.11.0

Если задано, «туннелирование vserver» ограничит вывод областью vserver.

Обратите внимание: не все подмножества поддерживаются на уровне vserver, а значение «all» приведёт к ошибке.

Примечания

Примечание

  • Модули с префиксом na_ontap предназначены для поддержки платформы хранения ONTAP.
  • HTTPS включён по умолчанию и рекомендуется к использованию. Чтобы включить HTTP в кластере, выполните следующие команды: «set -privilege advanced;» «system services web modify -http-enabled true;»

Примеры

- name: Get NetApp info as Cluster Admin (Password Authentication)
  netapp.ontap.na_ontap_info:
    hostname: "na-vsim"
    username: "admin"
    password: "admins_password"
  register: ontap_info
- debug:
    msg: "{{ ontap_info.ontap_info }}"

- name: Get NetApp version as Vserver admin
  netapp.ontap.na_ontap_info:
    hostname: "na-vsim"
    username: "vsadmin"
    vserver: trident_svm
    password: "vsadmins_password"

- name: run ontap info module using vserver tunneling and ignoring errors
  netapp.ontap.na_ontap_info:
    hostname: "na-vsim"
    username: "admin"
    password: "admins_password"
    vserver: trident_svm
    summary: true
    continue_on_error:
      - missing_vserver_api_error
      - rpc_error

- name: Limit Info Gathering to Aggregate Information as Cluster Admin
  netapp.ontap.na_ontap_info:
    hostname: "na-vsim"
    username: "admin"
    password: "admins_password"
    gather_subset: "aggregate_info"
  register: ontap_info

- name: Limit Info Gathering to Volume and Lun Information as Cluster Admin
  netapp.ontap.na_ontap_info:
    hostname: "na-vsim"
    username: "admin"
    password: "admins_password"
    gather_subset:
      - volume_info
      - lun_info
  register: ontap_info

- name: Gather all info except for volume and lun information as Cluster Admin
  netapp.ontap.na_ontap_info:
    hostname: "na-vsim"
    username: "admin"
    password: "admins_password"
    gather_subset:
      - "!volume_info"
      - "!lun_info"
  register: ontap_info

- name: Gather Volume move information for a specific volume
  netapp.ontap.na_ontap_info:
    hostname: "na-vsim"
    username: "admin"
    password: "admins_password"
    gather_subset: volume_move_target_aggr_info
    volume_move_target_aggr_info:
      volume_name: carchitest
      vserver: ansible

- name: run ontap info module for aggregate module, requesting specific fields
  netapp.ontap.na_ontap_info:
    # <<: *login
    gather_subset: aggregate_info
    desired_attributes:
      aggr-attributes:
      aggr-inode-attributes:
        files-private-used:
      aggr-raid-attributes:
        aggregate-type:
    use_native_zapi_tags: true
    register: ontap
- debug: var=ontap

- name: run ontap info to get offline volumes with dp in the name
  netapp.ontap.na_ontap_info:
    # <<: *cert_login
    gather_subset: volume_info
    query:
      volume-attributes:
        volume-id-attributes:
          name: '*dp*'
        volume-state-attributes:
          state: offline
    desired_attributes:
      volume-attributes:
        volume-id-attributes:
          name:
        volume-state-attributes:
          state:
  register: ontap
- debug: var=ontap

Возвращаемые значения

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

Ключ

Описание

ontap_info

словарь

Возвращает различную информацию о конфигурации кластера NetApp.

Возвращается: всегда

Пример: "{ \"ontap_info\": { \"active_directory_account_info\": {...}, \"aggregate_info\": {...}, \"autosupport_check_info\": {...}, \"cluster_identity_info\": {...}, \"cluster_image_info\": {...}, \"cluster_node_info\": {...}, \"igroup_info\": {...}, \"iscsi_service_info\": {...}, \"license_info\": {...}, \"lun_info\": {...}, \"metrocluster_check_info\": {...}, \"metrocluster_info\": {...}, \"metrocluster_node_info\": {...}, \"net_dns_info\": {...}, \"net_ifgrp_info\": {...}, \"net_interface_info\": {...}, \"net_interface_service_policy_info\": {...}, \"net_port_info\": {...}, \"ontap_system_version\": {...}, \"ontap_version\": {...}, \"ontapi_version\": {...}, \"qos_policy_info\": {...}, \"qos_adaptive_policy_info\": {...}, \"qtree_info\": {...}, \"quota_policy_info\": {..}, \"quota_report_info\": {...}, \"security_key_manager_key_info\": {...}, \"security_login_account_info\": {...}, \"snapmirror_info\": {...} \"snapmirror_destination_info\": {...} \"storage_bridge_info\": {...} \"storage_failover_info\": {...}, \"volume_info\": {...}, \"vserver_login_banner_info\": {...}, \"vserver_motd_info\": {...}, \"vserver_info\": {...}, \"vserver_nfs_info\": {...}, \"vscan_status_info\": {...}, \"vscan_scanner_pool_info\": {...}, \"vscan_connection_status_all_info\": {...}, \"vscan_connection_extended_stats_info\": {...} }"

Авторы

  • Piotr Olczak (@dprts)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/netapp/ontap/na_ontap_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API