Модуль netapp.ontap.na_ontap_restit — запуск любого REST API в ONTAP от NetApp

Описание

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

Требования

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

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

Параметры

Примечания

Примеры

-
  name: Ontap REST API
  hosts: localhost
  gather_facts: false
  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
      netapp.ontap.na_ontap_restit:
        <<: *login
        api: cluster/software
      register: result
    - name: Assertions
      ansible.builtin.assert:
        that: result.status_code==200
        quiet: true

    - name: Run ontap REST API command as cluster admin
      netapp.ontap.na_ontap_restit:
        <<: *login
        api: cluster/software
        query:
          fields: version
      register: result
    - name: Assertions
      ansible.builtin.assert:
        that: result.status_code==200
        quiet: true

    - name: Run ontap REST API command as cluster admin
      netapp.ontap.na_ontap_restit:
        <<: *login
        api: svm/svms
      register: result
    - name: Assertions
      ansible.builtin.assert:
        that: result.status_code==200
        quiet: true

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

    - name: Run ontap REST API command as vsadmin
      netapp.ontap.na_ontap_restit:
        <<: *svm_login
        api: svm/svms
      register: result
    - name: Assertions
      ansible.builtin.assert:
        that: result.status_code==200
        quiet: true

    - name: Run ontap REST API command as vserver tunneling
      netapp.ontap.na_ontap_restit:
        <<: *login
        api: storage/volumes
        vserver_name: ansibleSVM
      register: result
    - name: Assertions
      ansible.builtin.assert:
        that: result.status_code==200
        quiet: true
    - name: Store UUID
      ansible.builtin.set_fact:
        uuid: "{{ result.response.records | json_query(get_uuid) }}"
      vars:
        get_uuid: "[? name=='deleteme_ln1'].uuid"

    - name: Run ontap REST API command as DELETE method with vserver tunneling
      netapp.ontap.na_ontap_restit:
        <<: *login
        api: "storage/volumes/{{ uuid[0] }}"
        method: DELETE
        vserver_name: ansibleSVM
        query:
          return_timeout: 60
      register: result
      when: uuid | length == 1
    - name: Assertions
      ansible.builtin.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
      netapp.ontap.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
    - name: Assertions
      ansible.builtin.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
      netapp.ontap.na_ontap_restit:
        <<: *login
        api: "storage/volumes/{{ result.response.records[0].uuid }}"
        method: DELETE
        vserver_name: ansibleSVM
        query:
          return_timeout: 60
      register: result
    - name: Assertions
      ansible.builtin.assert:
        that: result.status_code==200
        quiet: true

    - name: Create a file
      # assuming credentials are set using module_defaults
      netapp.ontap.na_ontap_restit:
        api: storage/volumes/f3c003cb-2974-11ed-b2f8-005056b38dae/files/laurent123.txt
        method: post
        files:
          data: 'some data'

    - name: Read a file
      # assuming credentials are set using module_defaults
      netapp.ontap.na_ontap_restit:
        api: storage/volumes/f3c003cb-2974-11ed-b2f8-005056b38dae/files/laurent123.txt
        method: get
        accept_header: "multipart/form-data"
        query:
          length: 100

    # error cases
    - name: Run ontap REST API command
      netapp.ontap.na_ontap_restit:
        <<: *login
        api: unknown/endpoint
      register: result
      ignore_errors: true
    - name: Assertions
      ansible.builtin.assert:
        that: result.status_code==404
        quiet: true

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

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