vs_vip#

States module for managing Applications Vs Vips.

async idem_vmware_alb.states.avilb.applications.vs_vip.present(hub, ctx, name: str, resource_id: str = None, bgp_peer_labels: List[str] = None, cloud_ref: str = None, configpb_attributes: configpb_attributes = None, dns_info: List[dns_info] = None, east_west_placement: bool = None, ipam_selector: ipam_selector = None, markers: List[markers] = None, tenant_ref: str = None, tier1_lr: str = None, use_standard_alb: bool = None, vip: List[vip] = None, vrf_context_ref: str = None, vsvip_cloud_config_cksum: str = None) → Dict[str, Any][source]#

None: None

Parameters:

name (str) – Idem name of the resource.
resource_id (str, Optional) – applications.vs_vip unique ID. Defaults to None.
bgp_peer_labels (List[str], Optional) – Select BGP peers, using peer label, for VsVip advertisement. Field introduced in 20.1.5. Maximum of 128 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
cloud_ref (str, Optional) – It is a reference to an object of type Cloud. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
configpb_attributes (dict[str, Any], Optional) –
configpb_attributes. Defaults to None.
- version (int, Optional):
  Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. Defaults to None.
dns_info (List[dict[str, Any]], Optional) –
Service discovery specific data including fully qualified domain name, type and Time-To-Live of the DNS record. Field introduced in 17.1.1. Maximum of 1000 items allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
- algorithm (str, Optional):
  Specifies the algorithm to pick the IP address(es) to be returned, when multiple entries are configured. This does not apply if num_records_in_response is 0. Default is consistent hash. Enum options - DNS_RECORD_RESPONSE_ROUND_ROBIN, DNS_RECORD_RESPONSE_CONSISTENT_HASH. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- cname (dict[str, Any], Optional):
  cname. Defaults to None.
  - cname (str):
    Canonical name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
- fqdn (str, Optional):
  Fully qualified domain name. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- metadata (str, Optional):
  Any metadata associated with this record. Field introduced in 17.2.2. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. Defaults to None.
- num_records_in_response (int, Optional):
  Specifies the number of records returned for this FQDN. Enter 0 to return all records. Default is 0. Allowed values are 0-20. Special values are 0- Return all records. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- ttl (int, Optional):
  Time to live for fqdn record. Default value is chosen from DNS profile for this cloud if no value provided. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- type (str, Optional):
  DNS record type. Enum options - DNS_RECORD_OTHER, DNS_RECORD_A, DNS_RECORD_NS, DNS_RECORD_CNAME, DNS_RECORD_SOA, DNS_RECORD_PTR, DNS_RECORD_HINFO, DNS_RECORD_MX, DNS_RECORD_TXT, DNS_RECORD_RP, DNS_RECORD_DNSKEY, DNS_RECORD_AAAA, DNS_RECORD_SRV, DNS_RECORD_OPT, DNS_RECORD_RRSIG, DNS_RECORD_AXFR, DNS_RECORD_ANY. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
east_west_placement (bool, Optional) – Force placement on all Service Engines in the Service Engine Group (Container clouds only). Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition. Defaults to None.
ipam_selector (dict[str, Any], Optional) –
ipam_selector. Defaults to None.
- labels (List[dict[str, Any]], Optional):
  Labels as key value pairs to select on. Field introduced in 20.1.3. Minimum of 1 items required. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
  - key (str):
    Key. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
  - value (str, Optional):
    Value. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
- type (str):
  Selector type. Enum options - SELECTOR_IPAM. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
markers (List[dict[str, Any]], Optional) –
List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. Defaults to None.
- key (str):
  Key for filter match. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
- values (List[str], Optional):
  Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
tenant_ref (str, Optional) – It is a reference to an object of type Tenant. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
tier1_lr (str, Optional) – This sets the placement scope of virtualservice to given tier1 logical router in Nsx-t. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
use_standard_alb (bool, Optional) – This overrides the cloud level default and needs to match the SE Group value in which it will be used if the SE Group use_standard_alb value is set. This is only used when FIP is used for VS on Azure Cloud. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
vip (List[dict[str, Any]], Optional) –
List of Virtual Service IPs and other shareable entities. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- auto_allocate_floating_ip (bool, Optional):
  Auto-allocate floating/elastic IP from the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition. Defaults to None.
- auto_allocate_ip (bool, Optional):
  Auto-allocate VIP from the provided subnet. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- auto_allocate_ip_type (str, Optional):
  Specifies whether to auto-allocate only a V4 address, only a V6 address, or one of each type. Enum options - V4_ONLY, V6_ONLY, V4_V6. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- V4_ONLY), Basic edition(Allowed values- V4_ONLY), Enterprise with Cloud Services edition. Defaults to None.
- availability_zone (str, Optional):
  Availability-zone to place the Virtual Service. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
- avi_allocated_fip (bool, Optional):
  (internal-use) FIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition. Defaults to None.
- avi_allocated_vip (bool, Optional):
  (internal-use) VIP allocated by Avi in the Cloud infrastructure. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- false), Basic edition(Allowed values- false), Enterprise with Cloud Services edition. Defaults to None.
- discovered_networks (List[dict[str, Any]], Optional):
  Discovered networks providing reachability for client facing Vip IP. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
  - network_ref (str):
    Discovered network for this IP. It is a reference to an object of type Network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
  - subnet (List[dict[str, Any]], Optional):
    Discovered subnet for this IP. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
    
    ip_addr (dict[str, Any]):
    ip_addr.
    
    addr (str):
    IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
    
    type (str):
    Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
    
    mask (int):
    Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
  - subnet6 (List[dict[str, Any]], Optional):
    Discovered IPv6 subnet for this IP. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
    
    ip_addr (dict[str, Any]):
    ip_addr.
    
    addr (str):
    IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
    
    type (str):
    Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
    
    mask (int):
    Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
- enabled (bool, Optional):
  Enable or disable the Vip. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- floating_ip (dict[str, Any], Optional):
  floating_ip. Defaults to None.
  - addr (str):
    IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
  - type (str):
    Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
- floating_ip6 (dict[str, Any], Optional):
  floating_ip6. Defaults to None.
  - addr (str):
    IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
  - type (str):
    Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
- floating_subnet6_uuid (str, Optional):
  If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IPv6 address allocation. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
- floating_subnet_uuid (str, Optional):
  If auto_allocate_floating_ip is True and more than one floating-ip subnets exist, then the subnet for the floating IP address allocation. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
- ip6_address (dict[str, Any], Optional):
  ip6_address. Defaults to None.
  - addr (str):
    IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
  - type (str):
    Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
- ip_address (dict[str, Any], Optional):
  ip_address. Defaults to None.
  - addr (str):
    IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
  - type (str):
    Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
- ipam_network_subnet (dict[str, Any], Optional):
  ipam_network_subnet. Defaults to None.
  - network_ref (str, Optional):
    Network for VirtualService IP allocation with Vantage as the IPAM provider. Network should be created before this is configured. It is a reference to an object of type Network. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
  - subnet (dict[str, Any], Optional):
    subnet. Defaults to None.
    
    ip_addr (dict[str, Any]):
    ip_addr.
    
    addr (str):
    IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
    
    type (str):
    Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
    
    mask (int):
    Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
  - subnet6 (dict[str, Any], Optional):
    subnet6. Defaults to None.
    
    ip_addr (dict[str, Any]):
    ip_addr.
    
    addr (str):
    IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
    
    type (str):
    Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
    
    mask (int):
    Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
  - subnet6_uuid (str, Optional):
    Subnet UUID or Name or Prefix for VirtualService IPv6 allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
  - subnet_uuid (str, Optional):
    Subnet UUID or Name or Prefix for VirtualService IP allocation with AWS or OpenStack as the IPAM provider. Only one of subnet or subnet_uuid configuration is allowed. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
- network_ref (str, Optional):
  Manually override the network on which the Vip is placed. It is a reference to an object of type Network. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- placement_networks (List[dict[str, Any]], Optional):
  Placement networks/subnets to use for vip placement. Field introduced in 18.2.5. Maximum of 10 items allowed. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
  - network_ref (str, Optional):
    Network to use for vip placement. It is a reference to an object of type Network. Field introduced in 18.2.5. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
  - subnet (dict[str, Any], Optional):
    subnet. Defaults to None.
    
    ip_addr (dict[str, Any]):
    ip_addr.
    
    addr (str):
    IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
    
    type (str):
    Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
    
    mask (int):
    Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
  - subnet6 (dict[str, Any], Optional):
    subnet6. Defaults to None.
    
    ip_addr (dict[str, Any]):
    ip_addr.
    
    addr (str):
    IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
    
    type (str):
    Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
    
    mask (int):
    Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
- port_uuid (str, Optional):
  (internal-use) Network port assigned to the Vip IP address. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- prefix_length (int, Optional):
  Mask applied for the Vip, non-default mask supported only for wildcard Vip. Allowed values are 0-32. Field introduced in 20.1.1. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- 32), Basic edition(Allowed values- 32), Enterprise with Cloud Services edition. Defaults to None.
- subnet (dict[str, Any], Optional):
  subnet. Defaults to None.
  - ip_addr (dict[str, Any]):
    ip_addr.
    
    addr (str):
    IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
    
    type (str):
    Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
  - mask (int):
    Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
- subnet6 (dict[str, Any], Optional):
  subnet6. Defaults to None.
  - ip_addr (dict[str, Any]):
    ip_addr.
    
    addr (str):
    IP address. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
    
    type (str):
    Enum options - V4, DNS, V6. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
  - mask (int):
    Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
- subnet6_uuid (str, Optional):
  If auto_allocate_ip is True, then the subnet for the Vip IPv6 address allocation. This field is applicable only if the VirtualService belongs to an Openstack or AWS cloud, in which case it is mandatory, if auto_allocate is selected. Field introduced in 18.1.1. Allowed in Enterprise edition with any value, Basic, Enterprise with Cloud Services edition. Defaults to None.
- subnet_uuid (str, Optional):
  If auto_allocate_ip is True, then the subnet for the Vip IP address allocation. This field is applicable only if the VirtualService belongs to an Openstack or AWS cloud, in which case it is mandatory, if auto_allocate is selected. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- vip_id (str, Optional):
  Unique ID associated with the vip. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
vrf_context_ref (str, Optional) – Virtual Routing Context that the Virtual Service is bound to. This is used to provide the isolation of the set of networks the application is attached to. It is a reference to an object of type VrfContext. Field introduced in 17.1.1. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
vsvip_cloud_config_cksum (str, Optional) – Checksum of cloud configuration for VsVip. Internally set by cloud connector. Field introduced in 17.2.9, 18.1.2. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.

Returns:

Dict[str, Any]

Example

idem_test_avilb.applications.vs_vip_is_present:
    avilb.avilb.applications.vs_vip.present:
    - bgp_peer_labels:
      - value
    - cloud_ref: string
    - configpb_attributes:
        version: int
    - dns_info:
      - algorithm: string
        cname:
          cname: string
        fqdn: string
        metadata: string
        num_records_in_response: int
        ttl: int
        type_: string
    - east_west_placement: bool
    - ipam_selector:
        labels:
        - key: string
          value: string
        type_: string
    - markers:
      - key: string
        values:
        - value
    - tenant_ref: string
    - tier1_lr: string
    - use_standard_alb: bool
    - vip:
      - auto_allocate_floating_ip: bool
        auto_allocate_ip: bool
        auto_allocate_ip_type: string
        availability_zone: string
        avi_allocated_fip: bool
        avi_allocated_vip: bool
        discovered_networks:
        - network_ref: string
          subnet:
          - ip_addr:
              addr: string
              type_: string
            mask: int
          subnet6:
          - ip_addr:
              addr: string
              type_: string
            mask: int
        enabled: bool
        floating_ip:
          addr: string
          type_: string
        floating_ip6:
          addr: string
          type_: string
        floating_subnet6_uuid: string
        floating_subnet_uuid: string
        ip6_address:
          addr: string
          type_: string
        ip_address:
          addr: string
          type_: string
        ipam_network_subnet:
          network_ref: string
          subnet:
            ip_addr:
              addr: string
              type_: string
            mask: int
          subnet6:
            ip_addr:
              addr: string
              type_: string
            mask: int
          subnet6_uuid: string
          subnet_uuid: string
        network_ref: string
        placement_networks:
        - network_ref: string
          subnet:
            ip_addr:
              addr: string
              type_: string
            mask: int
          subnet6:
            ip_addr:
              addr: string
              type_: string
            mask: int
        port_uuid: string
        prefix_length: int
        subnet:
          ip_addr:
            addr: string
            type_: string
          mask: int
        subnet6:
          ip_addr:
            addr: string
            type_: string
          mask: int
        subnet6_uuid: string
        subnet_uuid: string
        vip_id: string
    - vrf_context_ref: string
    - vsvip_cloud_config_cksum: string

async idem_vmware_alb.states.avilb.applications.vs_vip.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any][source]#

None: None

Parameters:

name (str) – Idem name of the resource.
resource_id (str, Optional) – applications.vs_vip unique ID. Defaults to None.

Returns:

Dict[str, Any]

Example

idem_test_avilb.applications.vs_vip_is_absent:
  avilb.avilb.applications.vs_vip.absent:

async idem_vmware_alb.states.avilb.applications.vs_vip.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe the resource in a way that can be recreated/managed with the corresponding “present” function

None: None

Args:

Returns:: Dict[str, Any]

Example

$ idem describe avilb.applications.vs_vip