Skip to content

Latest commit

 

History

History
685 lines (665 loc) · 28.6 KB

avi_nsxtsegmentruntime.rst

File metadata and controls

685 lines (665 loc) · 28.6 KB

vmware.alb.avi_nsxtsegmentruntime

Module for setup of NsxtSegmentRuntime Avi RESTful Object

Synopsis

Parameters

Parameter Choices/Defaults Comments
state
str
  • absent
  • present ←
- The state that should be applied on the entity.
avi_api_update_method
str
  • put ←
  • patch
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
avi_api_patch_op
str
  • add ←
  • replace
  • delete
  • remove
- Patch operation to use when using avi_api_update_method as patch.
avi_patch_path
str
- Patch path to use when using avi_api_update_method as patch.
avi_patch_value
str
- Patch value to use when using avi_api_update_method as patch.
cloud_ref
str
- Nsxt segment belongs to cloud.
- It is a reference to an object of type cloud.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
dhcp6_ranges
list
- V6 dhcp ranges configured in nsxt.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
dhcp_enabled
bool
- Ip address management scheme for this segment associated network.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
dhcp_ranges
list
- Dhcp ranges configured in nsxt.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
name
str
- Segment object name.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
nw_name
str
- Network name.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
nw_ref
str
- Corresponding network object in avi.
- It is a reference to an object of type network.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
opaque_network_id
str
- Opaque network id.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
origin_id
str
- Origin id applicable to security only cloud.
- Field introduced in 22.1.2.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
security_only_nsxt
bool
- Nsxt segment belongs to security only cloud.
- Field introduced in 22.1.2.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
segment_gw
str
- Segment gateway.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
segment_gw6
str
- V6 segment gateway.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
segment_id
str
- Segment id.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
segname
str
- Segment name.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
subnet
str
- Segment cidr.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
subnet6
str
- V6 segment cidr.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
tenant_ref
str
- Nsxt segment belongs to tenant.
- It is a reference to an object of type tenant.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
tier1_id
str
- Tier1 router id.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
uuid
str
- Uuid.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
vlan_ids
list
- Segment vlan ids.
- Field introduced in 20.1.5.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
vrf_context_ref
str
- Corresponding vrf context object in avi.
- It is a reference to an object of type vrfcontext.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "avi_user"
      password: "avi_password"
      controller: "192.168.138.18"
      api_version: "21.1.1"
  tasks:
    - name: Example to create NsxtSegmentRuntime object
      avi_nsxtsegmentruntime:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_nsxtsegmentruntime

Authors