avi_prioritylabels - Module for setup of PriorityLabels Avi RESTful Object

New in version 2.4.

Synopsis

Requirements (on host that executes module)

  • avisdk

Options

parameter required default choices comments
api_version
 no
Avi API version of to use for Avi API and objects.
cloud_ref
 no
It is a reference to an object of type cloud.
controller
 no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
description
 no
A description of the priority labels.
equivalent_labels
 no
Equivalent priority labels in descending order.
name
 yes
The name of the priority labels.
password
 no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
state
 no present
  • absent
  • present
The state that should be applied on the entity.
tenant
 no admin
Name of tenant used for all Avi API calls and context of object.
tenant_ref
 no
It is a reference to an object of type tenant.
tenant_uuid
 no
UUID of tenant used for all Avi API calls and context of object.
url
 no
Avi controller URL of the object.
username
 no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
 no
Uuid of the priority labels.

Examples

- name: Example to create PriorityLabels object
  avi_prioritylabels:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_prioritylabels

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
obj
PriorityLabels (api/prioritylabels) object
 success, changed dict

Status

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

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

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