Spec-Zone.ru › Ansible

Модуль netapp.ontap.na_ontap_info – Сбор информации о NetApp

Примечание

Этот модуль является частью коллекции netapp.ontap (версия 22.12.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

Требования

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

  • Ansible 2.9 или более поздние версии - рекомендуется версия 2.12 или более поздняя.
  • Python3 - рекомендуется версия 3.9 или более поздняя.
  • При использовании ZAPI, netapp-lib 2018.11.13 или более поздняя (установите с помощью «pip install netapp-lib»), strongly рекомендуется netapp-lib 2020.3.12, так как она обеспечивает более подробное сообщение об ошибках при проблемах с подключением
  • физическая или виртуальная кластерная система Data ONTAP, модули поддерживают Data ONTAP 9.1 и более поздние версии, REST-поддержка требует ONTAP 9.6 или более поздние версии
  • netapp_lib

Параметры

Параметр

Комментарии

cert_filepath

string

added in netapp.ontap 20.6.0

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

не поддерживается с python 2.6.

continue_on_error

list / elements=string

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

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

Ошибки в списке сообщаются в выводе, в соответствующем элементе информации, как запись «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 будет завершаться с ошибкой при любой ошибке, их нельзя использовать ни с каким другим ключевым словом.

Default: ["never"]

desired_attributes

dictionary

added in netapp.ontap 20.6.0

Расширенная функция, требующая понимания внутренних механизмов ZAPI.

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

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

XML-тег <tag>value</tag> - это словарь с тегом в качестве ключа.

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

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

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

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

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

feature_flags

dictionary

added in netapp.ontap 20.5.0

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

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

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

gather_subset

list / elements=string

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

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.

Default: ["all"]

hostname

string / required

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

http_port

integer

Переопределить порт по умолчанию (80 или 443) этим портом

https

boolean

Включить и отключить https.

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

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

Choices:

  • false ← (default)
  • true

key_filepath

string

added in netapp.ontap 20.6.0

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

max_records

integer

added in netapp.ontap 20.2.0

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

Default: 1024

ontapi

integer

Версия API ontap для использования

password

aliases: pass

string

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

запрос

словарь

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

Расширенная функция, требующая понимания внутренней работы ZAPI.

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

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

Тег XML <tag>значение</tag> представляет собой словарь с тегом в качестве ключа.

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

Например, <tag/> отображается как tag:

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

состояние

строка

устарело начиная с 21.1.0.

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

резюме

булево

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

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

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

Варианты:

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

использовать_родные_теги_zapi

булево

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

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

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

Варианты:

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

использовать_rest

строка

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

никогда – всегда будет использовать ZAPI, если модуль поддерживает ZAPI. Может быть выдано сообщение об ошибке, если опция REST не поддерживается в ZAPI.

авто – всегда будет использовать ZAPI.

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

имя_пользователя

псевдонимы: пользователь

строка

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

Дополнительную информацию можно найти в документации https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/.

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

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

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

проверить_сертификаты

булево

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

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

Варианты:

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

информация_о_целевом_агрегате_перемещения_тома

словарь

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

Необходимые параметры для volume_move_target_aggr_info

имя_тома

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

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

Имя тома, для которого требуется информация о целевом агрегате.

vserver

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

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

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

vserver

строка

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

Если присутствует, ‘vserver tunneling’ ограничит вывод до области 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netapp/ontap/na_ontap_info_module.html

Spec-Zone.ru

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