avi_serviceengine – Module for setup of ServiceEngine Avi RESTful Object

From Get docs
Ansible/docs/2.7/modules/avi serviceengine module


avi_serviceengine – Module for setup of ServiceEngine Avi RESTful Object

New in version 2.4.


Synopsis

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.

availability_zone

-

Availability_zone of serviceengine.

avi_api_patch_op

-

added in 2.5

  • add
  • replace
  • delete

Patch operation to use when using avi_api_update_method as patch.

avi_api_update_method

-

added in 2.5

  • put

  • patch

Default method for object update is HTTP PUT.

Setting to patch will override that behavior to use HTTP PATCH.

avi_credentials

-

added in 2.5

Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.

cloud_ref

-

It is a reference to an object of type cloud.

container_mode

boolean

  • no
  • yes

Boolean flag to set container_mode.

Default value when not specified in API or module is interpreted by Avi Controller as False.

container_type

-

Enum options - container_type_bridge, container_type_host, container_type_host_dpdk.

Default value when not specified in API or module is interpreted by Avi Controller as CONTAINER_TYPE_HOST.

controller

-

Default:

""

IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.

controller_created

boolean

  • no
  • yes

Boolean flag to set controller_created.

Default value when not specified in API or module is interpreted by Avi Controller as False.

controller_ip

-

Controller_ip of serviceengine.

data_vnics

-

List of vnic.

enable_state

-

Inorder to disable se set this field appropriately.

Enum options - SE_STATE_ENABLED, SE_STATE_DISABLED_FOR_PLACEMENT, SE_STATE_DISABLED, SE_STATE_DISABLED_FORCE.

Default value when not specified in API or module is interpreted by Avi Controller as SE_STATE_ENABLED.

flavor

-

Flavor of serviceengine.

host_ref

-

It is a reference to an object of type vimgrhostruntime.

hypervisor

-

Enum options - default, vmware_esx, kvm, vmware_vsan, xen.

mgmt_vnic

-

Vnic settings for serviceengine.

name

-

Name of the object.

Default value when not specified in API or module is interpreted by Avi Controller as VM name unknown.

password

-

Default:

""

Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.

resources

-

Seresources settings for serviceengine.

se_group_ref

-

It is a reference to an object of type serviceenginegroup.

state

-

  • absent
  • present

The state that should be applied on the entity.

tenant

-

Default:

"admin"

Name of tenant used for all Avi API calls and context of object.

tenant_ref

-

It is a reference to an object of type tenant.

tenant_uuid

-

Default:

""

UUID of tenant used for all Avi API calls and context of object.

url

-

Avi controller URL of the object.

username

-

Default:

""

Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.

uuid

-

Unique object identifier of the object.



Notes

Note


Examples

- name: Example to create ServiceEngine object
  avi_serviceengine:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_serviceengine

Return Values

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

Key Returned Description

obj

dictionary

success, changed

ServiceEngine (api/serviceengine) object





Status

Authors

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.7/modules/avi_serviceengine_module.html