netapp.ontap.na_ontap_restit – NetApp ONTAP Выполнить любой REST API на ONTAP

• Описание
• Требования
• Параметры
• Примечания
• Примеры
• Значения возврата

Описание

• Вызов REST API на ONTAP.
• REST API кластера выполняются с использованием учетной записи администратора кластера.
• REST API сервера виртуальных машин можно выполнять с использованием учетной записи vsadmin или с использованием туннелирования сервера виртуальных машин (администратор кластера с параметрами vserver_).
• В случае успеха возвращается словарь JSON, как response
• В случае ошибки REST API, status_code, error_code, error_message устанавливаются для помощи в диагностике проблемы,
• и вызов отмечается как ошибка («failed»).
• Другие ошибки (например, проблемы с подключением) сообщаются как ошибка Ansible.

Требования

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

• Физическая или виртуальная кластеризованная система Data ONTAP. Модули поддерживают Data ONTAP 9.1 и более поздние версии.
• Поддержка REST требуется для ONTAP 9.6 или более поздних версий.
• Ansible 2.6
• Настоятельно рекомендуется использовать Ansible 2.9 или более поздние версии, так как это позволяет использовать новую систему доставки коллекций.
• Python2 netapp-lib (2017.10.30) или более поздние версии. Установите с помощью «pip install netapp-lib»
• Python3 netapp-lib (2018.11.13) или более поздние версии. Установите с помощью «pip install netapp-lib»
• netapp-lib 2020.3.12 настоятельно рекомендуется, так как он обеспечивает более подробное сообщение об ошибках при подключении.
• Для включения http в кластере необходимо выполнить следующие команды: «set -privilege advanced;» «system services web modify -http-enabled true;»

Параметры

Примечания

Примеры

-
  name: Ontap REST API
  hosts: localhost
  gather_facts: False
  collections:
    - netapp.ontap
  vars:
    login: &login
      hostname: "{{ admin_ip }}"
      username: "{{ admin_username }}"
      password: "{{ admin_password }}"
      https: true
      validate_certs: false
    svm_login: &svm_login
      hostname: "{{ svm_admin_ip }}"
      username: "{{ svm_admin_username }}"
      password: "{{ svm_admin_password }}"
      https: true
      validate_certs: false

  tasks:
    - name: run ontap REST API command as cluster admin
      na_ontap_restit:
        <<: *login
        api: cluster/software
      register: result
    - debug: var=result
    - assert: { that: result.status_code==200, quiet: True }

    - name: run ontap REST API command as cluster admin
      na_ontap_restit:
        <<: *login
        api: cluster/software
        query:
          fields: version
      register: result
    - debug: var=result
    - assert: { that: result.status_code==200, quiet: True }

    - name: run ontap REST API command as cluster admin
      na_ontap_restit:
        <<: *login
        api: svm/svms
      register: result
    - debug: var=result
    - assert: { that: result.status_code==200, quiet: True }

    - name: run ontap REST API command as cluster admin
      na_ontap_restit:
        <<: *login
        api: svm/svms
        query:
          fields: aggregates,cifs,nfs,uuid
          query_fields: name
          query: trident_svm
        hal_linking: true
      register: result
    - debug: var=result

    - name: run ontap REST API command as vsadmin
      na_ontap_restit:
        <<: *svm_login
        api: svm/svms
      register: result
    - debug: var=result
    - assert: { that: result.status_code==200, quiet: True }

    - name: run ontap REST API command as vserver tunneling
      na_ontap_restit:
        <<: *login
        api: storage/volumes
        vserver_name: ansibleSVM
      register: result
    - debug: var=result
    - assert: { that: result.status_code==200, quiet: True }
    - set_fact:
        uuid: "{{ result.response.records | json_query(get_uuid) }}"
      vars:
        get_uuid: "[? name=='deleteme_ln1'].uuid"
    - debug: var=uuid

    - name: run ontap REST API command as DELETE method with vserver tunneling
      na_ontap_restit:
        <<: *login
        api: "storage/volumes/{{ uuid[0] }}"
        method: DELETE
        vserver_name: ansibleSVM
        query:
          return_timeout: 60
      register: result
      when: uuid|length == 1
    - debug: var=result
    - assert: { that: result.skipped|default(false) or result.status_code|default(404) == 200, quiet: True }

    - name: run ontap REST API command as POST method with vserver tunneling
      na_ontap_restit:
        <<: *login
        api: storage/volumes
        method: POST
        vserver_name: ansibleSVM
        query:
          return_records: "true"
          return_timeout: 60
        body:
          name: deleteme_ln1
          aggregates:
            - name: aggr1
      register: result
    - debug: var=result
    - assert: { that: result.status_code==201, quiet: True }

    - name: run ontap REST API command as DELETE method with vserver tunneling
      # delete test volume if present
      na_ontap_restit:
        <<: *login
        api: "storage/volumes/{{ result.response.records[0].uuid }}"
        method: DELETE
        vserver_name: ansibleSVM
        query:
          return_timeout: 60
      register: result
    - debug: var=result
    - assert: { that: result.status_code==200, quiet: True }

# error cases
    - name: run ontap REST API command
      na_ontap_restit:
        <<: *login
        api: unknown/endpoint
      register: result
      ignore_errors: True
    - debug: var=result
    - assert: { that: result.status_code==404, quiet: True }

Значения возврата

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

Авторы

• Команда NetApp Ansible (@carchi8py) <ng-ansibleteam@netapp.com>