Documentation

avi_serviceengine - Module for setup of ServiceEngine Avi RESTful Object

New in version 2.4.

Synopsis

Options

parameter required default choices comments
api_version
 no
Avi API version of to use for Avi API and objects.
availability_zone
 no
Availability_zone of serviceengine.
cloud_ref
 no
It is a reference to an object of type cloud.
container_mode
 no
Boolean flag to set container_mode.
Default value when not specified in API or module is interpreted by Avi Controller as False.
container_type
 no
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
 no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
controller_created
 no
Boolean flag to set controller_created.
Default value when not specified in API or module is interpreted by Avi Controller as False.
controller_ip
 no
Controller_ip of serviceengine.
data_vnics
 no
List of vnic.
enable_state
 no
Inorder to disable se set this field appropriately.
Enum options - SE_STATE_ENABLED, SE_STATE_DISABLED_FOR_PLACEMENT, SE_STATE_DISABLED.
Default value when not specified in API or module is interpreted by Avi Controller as SE_STATE_ENABLED.
flavor
 no
Flavor of serviceengine.
host_ref
 no
It is a reference to an object of type vimgrhostruntime.
hypervisor
 no
Enum options - default, vmware_esx, kvm, vmware_vsan, xen.
mgmt_vnic
 no
Vnic settings for serviceengine.
name
 no
Name of the object.
Default value when not specified in API or module is interpreted by Avi Controller as VM name unknown.
password
 no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
resources
 no
Seresources settings for serviceengine.
se_group_ref
 no
It is a reference to an object of type serviceenginegroup.
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
Unique object identifier of the object.

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 Return Values, the following are the fields unique to this module:

name description returned type sample
obj
ServiceEngine (api/serviceengine) 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.