Skip to content

Latest commit

 

History

History
2137 lines (2103 loc) · 109 KB

avi_albservicesconfig.rst

File metadata and controls

2137 lines (2103 loc) · 109 KB

vmware.alb.avi_albservicesconfig

Module for setup of ALBServicesConfig 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.
app_signature_config
dict / elements=dictionary
required: true
- Default values for application signature sync.
- Field introduced in 20.1.4.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
app_signature_sync_interval
int
- Application signature db sync interval in minutes.
- Allowed values are 1440-10080.
- Field introduced in 20.1.4.
- Unit is min.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Special default for essentials edition is 1440, basic edition is 1440, enterprise edition is 1440.
- Default value when not specified in API or module is interpreted by Avi Controller as 1440.
asset_contact
dict / elements=dictionary
- Default contact for this controller cluster.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
account_id
str
- Id of primary account of the portal user.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
account_name
str
- Name of primary account of the portal user.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
email
str
- Email id of the portal user.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
managed_accounts
list / elements=dictionary
- Information about all the accounts managed by user in the customer portal.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id
str
- Id of an account in the customer portal.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name
str
- Account to which the customer portal user belongs.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
users
list / elements=dictionary
- Information about users within the account in the customer portal.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
email
str
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name
str
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
phone
str
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
name
str
- Name of the portal user.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
phone
str
- Phone number of the user.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
case_config
dict / elements=dictionary
required: true
- Default values for case management.
- Field introduced in 21.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
additional_emails
list / elements=string
- Additional emails to get notified when the case gets created.
- Field introduced in 30.2.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
enable_auto_case_creation_on_controller_failure
bool
- Enable pro-active support case creation when a controller failure occurs.
- Field introduced in 21.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
enable_auto_case_creation_on_se_failure
bool
- Enable pro-active support case creation when a service engine failure occurs.
- Field introduced in 21.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
enable_cleanup_of_attached_files
bool
- Enable cleanup of successfully attached files to support case.
- Field introduced in 21.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
- Special default for essentials edition is false, basic edition is false, enterprise edition is true.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
configpb_attributes
dict / elements=dictionary
- Protobuf versioning for config pbs.
- Field introduced in 21.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
version
int
- Version sequence number that monotonically advances with each configuration update event.
- Field introduced in 21.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 1.
feature_opt_in_status
dict / elements=dictionary
required: true
- Features opt-in for pulse cloud services.
- Field introduced in 20.1.1.
enable_appsignature_sync
bool
- Enable to receive application specific signature updates.
- Field introduced in 20.1.4.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
enable_auto_case_creation_on_se_failure
bool
- This field is deprecated.
- Field deprecated in 21.1.1.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
enable_auto_case_creation_on_system_failure
bool
- This field is deprecated.
- Field deprecated in 21.1.1.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
enable_auto_download_waf_signatures
bool
- This field is deprecated.
- Field deprecated in 21.1.1.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
enable_ip_reputation
bool
- Enable to receive ip reputation updates.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
enable_pulse_case_management
bool
- Enable pulse cloud services case management.
- Field introduced in 21.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
- Special default for essentials edition is false, basic edition is false, enterprise edition is true.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
enable_pulse_inventory
bool
- Enable pulse cloud services inventory.
- Field introduced in 30.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
- Special default for essentials edition is false, basic edition is false, enterprise edition is false.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
enable_pulse_waf_management
bool
- Enable to receive waf crs updates.
- Field introduced in 21.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
- Special default for essentials edition is false, basic edition is false, enterprise edition is true.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
enable_user_agent_db_sync
bool
- Enable to receive bot management updates.
- Field introduced in 21.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
enable_waf_signatures_notifications
bool
- This field is deprecated.
- Field deprecated in 21.1.1.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise only with addon license, enterprise with cloud services edition.
- Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
- Special default for enterprise edition is false, essentials edition is false, basic edition is false.
inventory_config
dict / elements=dictionary
required: true
- Inventory configurations for pulse cloud services.
- Field introduced in 30.2.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
enable_search_info
bool
- Names, ip's of vs, pool(poolgroup) servers would be searchable on cloud console.
- Field introduced in 30.2.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
ip_reputation_config
dict / elements=dictionary
required: true
- Default values to be used for ip reputation sync.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
enable_ipv4_reputation
bool
- Enable ipv4 reputation.
- Field introduced in 31.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
enable_ipv6_reputation
bool
- Enable ipv6 reputation.
- Field introduced in 31.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
ip_reputation_file_object_expiry_duration
int
- Ip reputation db file object expiry duration in days.
- Allowed values are 1-7.
- Field introduced in 20.1.1.
- Unit is days.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 3.
ip_reputation_sync_interval
int
- Ip reputation db sync interval in minutes.
- Allowed values are 30-1440.
- Field introduced in 20.1.1.
- Unit is min.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- 60), basic (allowed values- 60) edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 60.
mode
str
- Mode helps log collection and upload.
- Enum options - MODE_UNKNOWN, SALESFORCE, SYSTEST, MYVMWARE, BROADCOM.
- Field introduced in 20.1.2.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- salesforce,myvmware,systest), basic (allowed values- salesforce,myvmware,systest) edition.
- Default value when not specified in API or module is interpreted by Avi Controller as MYVMWARE.
name
str
- Name of the albservicesconfig object.
- Field introduced in 30.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
polling_interval
int
- Time interval in minutes.
- Allowed values are 5-60.
- Field introduced in 18.2.6.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 10.
portal_url
str
required: true
- The fqdn or ip address of the pulse cloud services.
- Field introduced in 18.2.6.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
saas_licensing_config
dict / elements=dictionary
required: true
- Saas licensing configuration.
- Field introduced in 21.1.3.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
enable_notional_reserve
bool
- Enable relaxed reservation norm allowing up to 2x free units( normally constrained to free license units ) to be reserved by upcoming se’s.
- Field introduced in 31.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
max_service_units
float
- Maximum service units limit for controller.
- Allowed values are 0-100000.
- Special values are 0 - infinite.
- Field introduced in 21.1.3.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 0.0.
reserve_service_units
float
- Minimum service units that always remain reserved on controller.
- Allowed values are 0-1000.
- Field introduced in 21.1.3.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 0.0.
session_config
dict / elements=dictionary
- Session configuration data.
- Field introduced in 30.2.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
session_headers
list / elements=dictionary
- Session headers.
- Field introduced in 30.2.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
name
str
- Header name.
- Field introduced in 30.2.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
value
str
- Header value.
- Field introduced in 30.2.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
split_proxy_configuration
dict / elements=dictionary
- Split proxy configuration to connect external pulse cloud services.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
host
str
- Proxy hostname or ip address.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
password
str
- Password for proxy.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
port
int
- Proxy port.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
username
str
- Username for proxy.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_config
dict / elements=dictionary
- Tenant based configuration data.
- Field introduced in 30.2.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
heartbeat_interval
int
- Heartbeat interval duration.
- Field introduced in 30.2.1.
- Unit is min.
- Allowed with any value in enterprise, enterprise with cloud services edition.
license_escrow_interval
int
- License escrow interval duration.
- Field introduced in 30.2.1.
- Unit is min.
- Allowed with any value in enterprise, enterprise with cloud services edition.
license_expiry_interval
int
- License expiry interval duration.
- Allowed values are 1-1440.
- Field introduced in 30.2.1.
- Unit is min.
- Allowed with any value in enterprise, enterprise with cloud services edition.
license_reconcile_interval
int
- License reconcile interval duration.
- Field introduced in 30.2.1.
- Unit is min.
- Allowed with any value in enterprise, enterprise with cloud services edition.
license_refresh_interval
int
- License refresh interval duration.
- Field introduced in 30.2.1.
- Unit is min.
- Allowed with any value in enterprise, enterprise with cloud services edition.
license_renewal_interval
int
- License renewal interval duration.
- Allowed values are 1-1440.
- Field introduced in 30.2.1.
- Unit is min.
- Allowed with any value in enterprise, enterprise with cloud services edition.
token_refresh_interval
int
- Token refresh interval duration.
- Allowed values are 1-240.
- Field introduced in 30.2.1.
- Unit is min.
- Allowed with any value in enterprise, enterprise with cloud services edition.
tenant_ref
str
- Tenant uuid associated with the object.
- It is a reference to an object of type tenant.
- Field introduced in 30.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
use_split_proxy
bool
- By default, pulse cloud services uses proxy added in system configuration.
- If it should use a separate proxy, set this flag to true and configure split proxy configuration.
- Field introduced in 20.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
use_tls
bool
- Secure the controller to pulse cloud services communication over tls.
- Field introduced in 20.1.3.
- Allowed with any value in enterprise, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as True.
user_agent_db_config
dict / elements=dictionary
required: true
- Default values for user agent db service.
- Field introduced in 21.1.1.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
allowed_batch_size
int
- Batch query limit.
- Allowed values are 1-500.
- Field introduced in 21.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- 500), basic (allowed values- 500) edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 500.
uuid
str
- Field introduced in 18.2.6.
- Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
waf_config
dict / elements=dictionary
required: true
- Default values for waf management.
- Field introduced in 21.1.1.
- Allowed with any value in essentials, basic, enterprise, enterprise with cloud services edition.
enable_auto_download_waf_signatures
bool
- Enable to automatically download new waf signatures/crs version to the controller.
- Field introduced in 21.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
enable_waf_signatures_notifications
bool
- Enable event notifications when new waf signatures/crs versions are available.
- Field introduced in 21.1.1.
- Allowed with any value in enterprise, enterprise with cloud services edition.
- Allowed in essentials (allowed values- false), basic (allowed values- false) edition.
- Special default for essentials edition is false, basic edition is false, enterprise edition is true.
- Default value when not specified in API or module is interpreted by Avi Controller as True.

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 ALBServicesConfig object
      avi_albservicesconfig:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_albservicesconfig

Authors