application_persistence_profile#

Exec module for managing Profiles Application Persistence Profiles.

async idem_vmware_alb.exec.avilb.profiles.application_persistence_profile.get(hub, ctx, resource_id: str = None, name: str = None, tenant_ref: str = None) → Dict[str, Any][source]#

None: None

Parameters:

resource_id (str) – profiles.application_persistence_profile unique ID.
name (str, Optional) – Idem name of the resource. Defaults to None.
tenant_ref (str, Optional) – Avi Tenant Header. Defaults to None.

Returns:

Dict[str, Any]

Examples

Resource State:

unmanaged_resource:
  exec.run:
    - path: avilb.profiles.application_persistence_profile.get
    - kwargs:
      resource_id: value

Exec call from the CLI:

idem exec avilb.profiles.application_persistence_profile.get resource_id=value

async idem_vmware_alb.exec.avilb.profiles.application_persistence_profile.list_(hub, ctx) → Dict[str, Any][source]#

None: None

Parameters:: name (str, Optional) – Idem name of the resource. Defaults to None.
Returns:: Dict[str, Any]

Examples

Resource State:

unmanaged_resources:
  exec.run:
    - path: avilb.profiles.application_persistence_profile.list
    - kwargs:

Exec call from the CLI:

idem exec avilb.profiles.application_persistence_profile.list

Describe call from the CLI:

$ idem describe avilb.profiles.application_persistence_profile

async idem_vmware_alb.exec.avilb.profiles.application_persistence_profile.create(hub, ctx, persistence_type: str, resource_id: str = None, name: str = None, app_cookie_persistence_profile: app_cookie_persistence_profile = None, configpb_attributes: configpb_attributes = None, description: str = None, hdr_persistence_profile: hdr_persistence_profile = None, http_cookie_persistence_profile: http_cookie_persistence_profile = None, ip_persistence_profile: ip_persistence_profile = None, is_federated: bool = None, markers: List[markers] = None, server_hm_down_recovery: str = None, tenant_ref: str = None) → Dict[str, Any][source]#

None: None

Parameters:

persistence_type (str) – Method used to persist clients to the same server for a duration of time or a session. Enum options - PERSISTENCE_TYPE_CLIENT_IP_ADDRESS, PERSISTENCE_TYPE_HTTP_COOKIE, PERSISTENCE_TYPE_TLS, PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS, PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER, PERSISTENCE_TYPE_APP_COOKIE, PERSISTENCE_TYPE_GSLB_SITE. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- PERSISTENCE_TYPE_CLIENT_IP_ADDRESS,PERSISTENCE_TYPE_HTTP_COOKIE), Basic edition(Allowed values- PERSISTENCE_TYPE_CLIENT_IP_ADDRESS,PERSISTENCE_TYPE_HTTP_COOKIE), Enterprise with Cloud Services edition.
resource_id (str, Optional) – profiles.application_persistence_profile unique ID. Defaults to None.
name (str, Optional) – Idem name of the resource. Defaults to None.
app_cookie_persistence_profile (dict[str, Any], Optional) –
app_cookie_persistence_profile. Defaults to None.
- encryption_key (str, Optional):
  Key to use for cookie encryption. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- prst_hdr_name (str):
  Header or cookie name for application cookie persistence. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
- timeout (int, Optional):
  The length of time after a client’s connections have closed before expiring the client’s persistence to a server. Allowed values are 1-720. Unit is MIN. 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.
description (str, Optional) – Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
hdr_persistence_profile (dict[str, Any], Optional) –
hdr_persistence_profile. Defaults to None.
- prst_hdr_name (str, Optional):
  Header name for custom header persistence. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
http_cookie_persistence_profile (dict[str, Any], Optional) –
http_cookie_persistence_profile. Defaults to None.
- always_send_cookie (bool, Optional):
  If no persistence cookie was received from the client, always send it. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- cookie_name (str, Optional):
  HTTP cookie name for cookie persistence. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- encryption_key (str, Optional):
  Key name to use for cookie encryption. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- http_only (bool, Optional):
  Sets the HttpOnly attribute in the cookie. Setting this helps to prevent the client side scripts from accessing this cookie, if supported by browser. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
- is_persistent_cookie (bool, Optional):
  When True, the cookie used is a persistent cookie, i.e. the cookie shouldn’t be used at the end of the timeout. By default, it is set to false, making the cookie a session cookie, which allows clients to use it even after the timeout, if the session is still open. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
- key (List[dict[str, Any]], Optional):
  Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
  - aes_key (str, Optional):
    Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
  - hmac_key (str, Optional):
    Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
  - name (str, Optional):
    name to use for cookie encryption. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- timeout (int, Optional):
  The maximum lifetime of any session cookie. No value or ‘zero’ indicates no timeout. Allowed values are 1-14400. Special values are 0- No Timeout. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
ip_persistence_profile (dict[str, Any], Optional) –
ip_persistence_profile. Defaults to None.
- ip_mask (int, Optional):
  Mask to be applied on client IP. This may be used to persist clients from a subnet to the same server. When set to 0, all requests are sent to the same server. Allowed values are 0-128. Field introduced in 18.2.7. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
- ip_persistent_timeout (int, Optional):
  The length of time after a client’s connections have closed before expiring the client’s persistence to a server. Allowed values are 1-720. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
is_federated (bool, Optional) – This field describes the object’s replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. . Field introduced in 17.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
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.
server_hm_down_recovery (str, Optional) – Specifies behavior when a persistent server has been marked down by a health monitor. Enum options - HM_DOWN_PICK_NEW_SERVER, HM_DOWN_ABORT_CONNECTION, HM_DOWN_CONTINUE_PERSISTENT_SERVER. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- HM_DOWN_PICK_NEW_SERVER), Basic edition(Allowed values- HM_DOWN_PICK_NEW_SERVER), Enterprise with Cloud Services edition. Defaults to None.
tenant_ref (str, Optional) – It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.

Returns:

Dict[str, Any]

Examples

Using in a state:

resource_is_present:
  avilb.profiles.application_persistence_profile.present:
    - persistence_type: value

Exec call from the CLI:

idem exec avilb.profiles.application_persistence_profile.create  persistence_type=value

async idem_vmware_alb.exec.avilb.profiles.application_persistence_profile.update(hub, ctx, resource_id: str, persistence_type: str, name: str = None, app_cookie_persistence_profile: app_cookie_persistence_profile = None, configpb_attributes: configpb_attributes = None, description: str = None, hdr_persistence_profile: hdr_persistence_profile = None, http_cookie_persistence_profile: http_cookie_persistence_profile = None, ip_persistence_profile: ip_persistence_profile = None, is_federated: bool = None, markers: List[markers] = None, server_hm_down_recovery: str = None, tenant_ref: str = None) → Dict[str, Any][source]#

None: None

Parameters:

resource_id (str) – profiles.application_persistence_profile unique ID.
persistence_type (str) – Method used to persist clients to the same server for a duration of time or a session. Enum options - PERSISTENCE_TYPE_CLIENT_IP_ADDRESS, PERSISTENCE_TYPE_HTTP_COOKIE, PERSISTENCE_TYPE_TLS, PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS, PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER, PERSISTENCE_TYPE_APP_COOKIE, PERSISTENCE_TYPE_GSLB_SITE. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- PERSISTENCE_TYPE_CLIENT_IP_ADDRESS,PERSISTENCE_TYPE_HTTP_COOKIE), Basic edition(Allowed values- PERSISTENCE_TYPE_CLIENT_IP_ADDRESS,PERSISTENCE_TYPE_HTTP_COOKIE), Enterprise with Cloud Services edition.
name (str, Optional) – Idem name of the resource. Defaults to None.
app_cookie_persistence_profile (dict[str, Any], Optional) –
app_cookie_persistence_profile. Defaults to None.
- encryption_key (str, Optional):
  Key to use for cookie encryption. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- prst_hdr_name (str):
  Header or cookie name for application cookie persistence. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.
- timeout (int, Optional):
  The length of time after a client’s connections have closed before expiring the client’s persistence to a server. Allowed values are 1-720. Unit is MIN. 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.
description (str, Optional) – Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
hdr_persistence_profile (dict[str, Any], Optional) –
hdr_persistence_profile. Defaults to None.
- prst_hdr_name (str, Optional):
  Header name for custom header persistence. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
http_cookie_persistence_profile (dict[str, Any], Optional) –
http_cookie_persistence_profile. Defaults to None.
- always_send_cookie (bool, Optional):
  If no persistence cookie was received from the client, always send it. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- cookie_name (str, Optional):
  HTTP cookie name for cookie persistence. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- encryption_key (str, Optional):
  Key name to use for cookie encryption. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- http_only (bool, Optional):
  Sets the HttpOnly attribute in the cookie. Setting this helps to prevent the client side scripts from accessing this cookie, if supported by browser. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
- is_persistent_cookie (bool, Optional):
  When True, the cookie used is a persistent cookie, i.e. the cookie shouldn’t be used at the end of the timeout. By default, it is set to false, making the cookie a session cookie, which allows clients to use it even after the timeout, if the session is still open. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
- key (List[dict[str, Any]], Optional):
  Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
  - aes_key (str, Optional):
    Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
  - hmac_key (str, Optional):
    Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
  - name (str, Optional):
    name to use for cookie encryption. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
- timeout (int, Optional):
  The maximum lifetime of any session cookie. No value or ‘zero’ indicates no timeout. Allowed values are 1-14400. Special values are 0- No Timeout. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
ip_persistence_profile (dict[str, Any], Optional) –
ip_persistence_profile. Defaults to None.
- ip_mask (int, Optional):
  Mask to be applied on client IP. This may be used to persist clients from a subnet to the same server. When set to 0, all requests are sent to the same server. Allowed values are 0-128. Field introduced in 18.2.7. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition. Defaults to None.
- ip_persistent_timeout (int, Optional):
  The length of time after a client’s connections have closed before expiring the client’s persistence to a server. Allowed values are 1-720. Unit is MIN. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
is_federated (bool, Optional) – This field describes the object’s replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. . Field introduced in 17.1.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.
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.
server_hm_down_recovery (str, Optional) – Specifies behavior when a persistent server has been marked down by a health monitor. Enum options - HM_DOWN_PICK_NEW_SERVER, HM_DOWN_ABORT_CONNECTION, HM_DOWN_CONTINUE_PERSISTENT_SERVER. Allowed in Enterprise edition with any value, Essentials edition(Allowed values- HM_DOWN_PICK_NEW_SERVER), Basic edition(Allowed values- HM_DOWN_PICK_NEW_SERVER), Enterprise with Cloud Services edition. Defaults to None.
tenant_ref (str, Optional) – It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. Defaults to None.

Returns:

Dict[str, Any]

Examples

Using in a state:

resource_is_present:
  avilb.profiles.application_persistence_profile.present:
    - resource_id: value
    - persistence_type: value

Exec call from the CLI:

idem exec avilb.profiles.application_persistence_profile.update resource_id=value, persistence_type=value

async idem_vmware_alb.exec.avilb.profiles.application_persistence_profile.delete(hub, ctx, resource_id: str, name: str = None) → Dict[str, Any][source]#

None: None

Parameters:

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

Returns:

Dict[str, Any]

Examples

Resource State:

resource_is_absent:
  avilb.profiles.application_persistence_profile.absent:
    - resource_id: value

Exec call from the CLI:

idem exec avilb.profiles.application_persistence_profile.delete resource_id=value