Docs4dev
Docs
ansible / 2.6 / modules / avi_gslbservice_patch_member_module.html

avi_gslbservice_patch_member - Avi API Module

New in version 2.5.

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
(added in 2.5)
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 Default:
"16.4.4"
Avi API version of to use for Avi API and objects.
avi_credentials
(added in 2.5)
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
controller Default:
""
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
data
HTTP body of GSLB Service Member in YAML or JSON format.
name
required
Name of the GSLB Service
params
Query parameters passed to the HTTP API.
password Default:
""
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
state
    Choices:
  • absent
  • present ←
The state that should be applied to the member. Member is
identified using field member.ip.addr.
tenant Default:
"admin"
Name of tenant used for all Avi API calls and context of object.
tenant_uuid Default:
""
UUID of tenant used for all Avi API calls and context of object.
username Default:
""
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.

Notes

Note

Examples

- name: Patch GSLB Service to add a new member and group
  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
  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
  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
dict
success, changed
Avi REST resource



Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/avi_gslbservice_patch_member_module.html