community.network.avi_gslbservice_patch_member – Avi API Module
Note
This plugin is part of the community.network collection (version 1.3.0).
To install it use: ansible-galaxy collection install community.network.
To use it in a playbook, specify: community.network.avi_gslbservice_patch_member.
Synopsis
- This module can be used for calling any resources defined in Avi REST API. https://avinetworks.com/
 - This module is useful for invoking HTTP Patch methods and accessing resources that do not have an REST object associated with them.
 
Requirements
The below requirements are needed on the host that executes this module.
- avisdk
 
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
|   api_context    dictionary    |    Avi API context that includes current session ID and CSRF Token.  This allows user to perform single login and re-use the session.   |  ||
|   api_version    string    |   Default: "16.4.4"   |    Avi API version of to use for Avi API and objects.   |  |
|   avi_credentials    dictionary    |    Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.   |  ||
|   api_version    string    |   Default: "16.4.4"   |    Avi controller version   |  |
|   controller    string    |    Avi controller IP or SQDN   |  ||
|   csrftoken    string    |    Avi controller API csrftoken to reuse existing session with session id   |  ||
|   password    string    |    Avi controller password   |  ||
|   port    string    |    Avi controller port   |  ||
|   session_id    string    |    Avi controller API session id to reuse existing session with csrftoken   |  ||
|   tenant    string    |   Default: "admin"   |    Avi controller tenant   |  |
|   tenant_uuid    string    |    Avi controller tenant UUID   |  ||
|   timeout    string    |   Default: 300   |    Avi controller request timeout   |  |
|   token    string    |    Avi controller API token   |  ||
|   username    string    |    Avi controller username   |  ||
|   avi_disable_session_cache_as_fact    boolean    |   
  |    It disables avi session information to be cached as a fact.   |  |
|   controller    string    |   Default: ""   |    IP address or hostname of the controller. The default value is the environment variable   AVI_CONTROLLER. |  |
|   data    string    |    HTTP body of GSLB Service Member in YAML or JSON format.   |  ||
|   name    string / required    |    Name of the GSLB Service   |  ||
|   params    string    |    Query parameters passed to the HTTP API.   |  ||
|   password    string    |   Default: ""   |    Password of Avi user in Avi controller. The default value is the environment variable   AVI_PASSWORD. |  |
|   state    string    |   
  |    The state that should be applied to the member. Member is  identified using field member.ip.addr.   |  |
|   tenant    string    |   Default: "admin"   |    Name of tenant used for all Avi API calls and context of object.   |  |
|   tenant_uuid    string    |   Default: ""   |    UUID of tenant used for all Avi API calls and context of object.   |  |
|   username    string    |   Default: ""   |    Username used for accessing Avi controller. The default value is the environment variable   AVI_USERNAME. |  |
Notes
Note
- For more information on using Ansible to manage Avi Network devices see https://www.ansible.com/ansible-avi-networks.
 
Examples
- name: Patch GSLB Service to add a new member and group
  community.network.avi_gslbservice_patch_member:
    controller: "{{ controller }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: gs-3
    api_version: 17.2.1
    data:
      group:
        name: newfoo
        priority: 60
        members:
          - enabled: true
            ip:
              addr:  10.30.10.66
              type: V4
            ratio: 3
- name: Patch GSLB Service to delete an existing member
  community.network.avi_gslbservice_patch_member:
    controller: "{{ controller }}"
    username: "{{ username }}"
    password: "{{ password }}"
    name: gs-3
    state: absent
    api_version: 17.2.1
    data:
      group:
        name: newfoo
        members:
          - enabled: true
            ip:
              addr:  10.30.10.68
              type: V4
            ratio: 3
- name: Update priority of GSLB Service Pool
  community.network.avi_gslbservice_patch_member:
    controller: ""
    username: ""
    password: ""
    name: gs-3
    state: present
    api_version: 17.2.1
    data:
      group:
        name: newfoo
        priority: 42
   Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | 
|---|---|---|
|   obj    dictionary    |  success, changed |   Avi REST resource   |  
Authors
- Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
 
    © 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.10/collections/community/network/avi_gslbservice_patch_member_module.html