You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

avi_vrfcontext - Module for setup of VrfContext Avi RESTful Object¶

New in version 2.4.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
- Status

Synopsis ¶

This module is used to configure VrfContext object
more examples at https://github.com/avinetworks/devops

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.
bgp_profile	no			Bgp local and peer info.
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`.
debugvrfcontext	no			Configure debug flags for vrf. Field introduced in 17.1.1.
description	no			User defined description for the object.
gateway_mon	no			Configure ping based heartbeat check for gateway in service engines of vrf.
internal_gateway_monitor	no			Configure ping based heartbeat check for all default gateways in service engines of vrf. Field introduced in 17.1.1.
name	yes			Name of the object.
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.
static_routes	no			List of staticroute.
system_default	no			Boolean flag to set system_default. Default value when not specified in API or module is interpreted by Avi Controller as False.
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			Unique object identifier of the object.

Examples ¶

- name: Example to create VrfContext object
  avi_vrfcontext:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_vrfcontext

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	VrfContext (api/vrfcontext) 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.