Avi ALBServicesConfig Object API

CLI ``` - show albservicesconfig - configure albservicesconfig ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 20.1.2
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /albservicesconfig
  2. post /albservicesconfig
  3. delete /albservicesconfig/{uuid}
  4. get /albservicesconfig/{uuid}
  5. patch /albservicesconfig/{uuid}
  6. put /albservicesconfig/{uuid}
Up
get /albservicesconfig
(albservicesconfigGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

ALBServicesConfigApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "asset_contact" : {
      "account_id" : "aeiou",
      "phone" : "aeiou",
      "account_name" : "aeiou",
      "name" : "aeiou",
      "email" : "aeiou",
      "managed_accounts" : [ {
        "name" : "aeiou",
        "id" : "aeiou",
        "users" : [ {
          "phone" : "aeiou",
          "name" : "aeiou",
          "email" : "aeiou"
        } ]
      } ]
    },
    "mode" : "aeiou",
    "feature_opt_in_status" : {
      "enable_auto_case_creation_on_system_failure" : true,
      "enable_auto_case_creation_on_se_failure" : true,
      "enable_auto_download_waf_signatures" : true,
      "enable_ip_reputation" : true,
      "enable_waf_signatures_notifications" : true
    },
    "split_proxy_configuration" : {
      "password" : "aeiou",
      "port" : 123,
      "host" : "aeiou",
      "username" : "aeiou"
    },
    "ip_reputation_config" : {
      "ip_reputation_sync_interval" : 123,
      "ip_reputation_file_object_expiry_duration" : 123
    },
    "portal_url" : "aeiou",
    "uuid" : "aeiou",
    "polling_interval" : 123,
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "proactive_support_defaults" : {
      "attach_tech_support" : true,
      "attach_core_dump" : true,
      "case_severity" : "aeiou"
    },
    "use_split_proxy" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ALBServicesConfigApiResponse

401

log in failed

Up
post /albservicesconfig
(albservicesconfigPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — ALBServicesConfig object creation

Return type

ALBServicesConfig

Example data

Content-Type: application/json
{
  "asset_contact" : {
    "account_id" : "aeiou",
    "phone" : "aeiou",
    "account_name" : "aeiou",
    "name" : "aeiou",
    "email" : "aeiou",
    "managed_accounts" : [ {
      "name" : "aeiou",
      "id" : "aeiou",
      "users" : [ {
        "phone" : "aeiou",
        "name" : "aeiou",
        "email" : "aeiou"
      } ]
    } ]
  },
  "mode" : "aeiou",
  "feature_opt_in_status" : {
    "enable_auto_case_creation_on_system_failure" : true,
    "enable_auto_case_creation_on_se_failure" : true,
    "enable_auto_download_waf_signatures" : true,
    "enable_ip_reputation" : true,
    "enable_waf_signatures_notifications" : true
  },
  "split_proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "ip_reputation_config" : {
    "ip_reputation_sync_interval" : 123,
    "ip_reputation_file_object_expiry_duration" : 123
  },
  "portal_url" : "aeiou",
  "uuid" : "aeiou",
  "polling_interval" : 123,
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "proactive_support_defaults" : {
    "attach_tech_support" : true,
    "attach_core_dump" : true,
    "case_severity" : "aeiou"
  },
  "use_split_proxy" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ALBServicesConfig

401

log in failed

Up
delete /albservicesconfig/{uuid}
(albservicesconfigUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /albservicesconfig/{uuid}
(albservicesconfigUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

ALBServicesConfig

Example data

Content-Type: application/json
{
  "asset_contact" : {
    "account_id" : "aeiou",
    "phone" : "aeiou",
    "account_name" : "aeiou",
    "name" : "aeiou",
    "email" : "aeiou",
    "managed_accounts" : [ {
      "name" : "aeiou",
      "id" : "aeiou",
      "users" : [ {
        "phone" : "aeiou",
        "name" : "aeiou",
        "email" : "aeiou"
      } ]
    } ]
  },
  "mode" : "aeiou",
  "feature_opt_in_status" : {
    "enable_auto_case_creation_on_system_failure" : true,
    "enable_auto_case_creation_on_se_failure" : true,
    "enable_auto_download_waf_signatures" : true,
    "enable_ip_reputation" : true,
    "enable_waf_signatures_notifications" : true
  },
  "split_proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "ip_reputation_config" : {
    "ip_reputation_sync_interval" : 123,
    "ip_reputation_file_object_expiry_duration" : 123
  },
  "portal_url" : "aeiou",
  "uuid" : "aeiou",
  "polling_interval" : 123,
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "proactive_support_defaults" : {
    "attach_tech_support" : true,
    "attach_core_dump" : true,
    "case_severity" : "aeiou"
  },
  "use_split_proxy" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ALBServicesConfig

401

log in failed

Up
patch /albservicesconfig/{uuid}
(albservicesconfigUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — ALBServicesConfig object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

ALBServicesConfig

Example data

Content-Type: application/json
{
  "asset_contact" : {
    "account_id" : "aeiou",
    "phone" : "aeiou",
    "account_name" : "aeiou",
    "name" : "aeiou",
    "email" : "aeiou",
    "managed_accounts" : [ {
      "name" : "aeiou",
      "id" : "aeiou",
      "users" : [ {
        "phone" : "aeiou",
        "name" : "aeiou",
        "email" : "aeiou"
      } ]
    } ]
  },
  "mode" : "aeiou",
  "feature_opt_in_status" : {
    "enable_auto_case_creation_on_system_failure" : true,
    "enable_auto_case_creation_on_se_failure" : true,
    "enable_auto_download_waf_signatures" : true,
    "enable_ip_reputation" : true,
    "enable_waf_signatures_notifications" : true
  },
  "split_proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "ip_reputation_config" : {
    "ip_reputation_sync_interval" : 123,
    "ip_reputation_file_object_expiry_duration" : 123
  },
  "portal_url" : "aeiou",
  "uuid" : "aeiou",
  "polling_interval" : 123,
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "proactive_support_defaults" : {
    "attach_tech_support" : true,
    "attach_core_dump" : true,
    "case_severity" : "aeiou"
  },
  "use_split_proxy" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ALBServicesConfig

401

log in failed

Up
put /albservicesconfig/{uuid}
(albservicesconfigUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — ALBServicesConfig object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

ALBServicesConfig

Example data

Content-Type: application/json
{
  "asset_contact" : {
    "account_id" : "aeiou",
    "phone" : "aeiou",
    "account_name" : "aeiou",
    "name" : "aeiou",
    "email" : "aeiou",
    "managed_accounts" : [ {
      "name" : "aeiou",
      "id" : "aeiou",
      "users" : [ {
        "phone" : "aeiou",
        "name" : "aeiou",
        "email" : "aeiou"
      } ]
    } ]
  },
  "mode" : "aeiou",
  "feature_opt_in_status" : {
    "enable_auto_case_creation_on_system_failure" : true,
    "enable_auto_case_creation_on_se_failure" : true,
    "enable_auto_download_waf_signatures" : true,
    "enable_ip_reputation" : true,
    "enable_waf_signatures_notifications" : true
  },
  "split_proxy_configuration" : {
    "password" : "aeiou",
    "port" : 123,
    "host" : "aeiou",
    "username" : "aeiou"
  },
  "ip_reputation_config" : {
    "ip_reputation_sync_interval" : 123,
    "ip_reputation_file_object_expiry_duration" : 123
  },
  "portal_url" : "aeiou",
  "uuid" : "aeiou",
  "polling_interval" : 123,
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "proactive_support_defaults" : {
    "attach_tech_support" : true,
    "attach_core_dump" : true,
    "case_severity" : "aeiou"
  },
  "use_split_proxy" : true
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK ALBServicesConfig

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. ALBServicesAccount
  2. ALBServicesAccountUser
  3. ALBServicesConfig
  4. ALBServicesConfigApiResponse
  5. ALBServicesUser
  6. IpReputationConfig
  7. PortalFeatureOptIn
  8. ProactiveSupportDefaults
  9. ProxyConfiguration

ALBServicesAccount Up

id (optional)
String ID of an Account in the customer portal. Field introduced in 20.1.1.
name (optional)
String Account to which the customer portal user belongs. Field introduced in 20.1.1.
users (optional)
array[ALBServicesAccountUser] Information about users within the account in the customer portal. Field introduced in 20.1.1.

ALBServicesAccountUser Up

email
String Field introduced in 20.1.1.
name
String Field introduced in 20.1.1.
phone
String Field introduced in 20.1.1.

ALBServicesConfig Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
asset_contact (optional)
ALBServicesUser Information about the default contact for this controller cluster. Field introduced in 20.1.1.
feature_opt_in_status
PortalFeatureOptIn Information about the portal features opted in for controller. Field introduced in 20.1.1.
ip_reputation_config
IpReputationConfig Default values to be used for IP Reputation sync. Field introduced in 20.1.1.
mode (optional)
String Mode helps log collection and upload. Enum options - SALESFORCE, SYSTEST, MYVMWARE. Field introduced in 20.1.2.
polling_interval (optional)
Integer Time interval in minutes. Allowed values are 5-60. Field introduced in 18.2.6. format: int32
portal_url
String The FQDN or IP address of the customer portal. Field introduced in 18.2.6.
proactive_support_defaults
ProactiveSupportDefaults Default values to be used during proactive case creation and techsupport attachment. Field introduced in 20.1.1.
split_proxy_configuration
ProxyConfiguration Split proxy configuration to connect external pulse services. Field introduced in 20.1.1.
url (optional)
String url
use_split_proxy (optional)
Boolean By default, use system proxy configuration.If true, use split proxy configuration. Field introduced in 20.1.1.
uuid (optional)
String Field introduced in 18.2.6.

ALBServicesConfigApiResponse Up

count
Integer format: int32
results
next (optional)

ALBServicesUser Up

account_id (optional)
String ID of primary account of the portal user. Field introduced in 20.1.1.
account_name (optional)
String Name of primary account of the portal user. Field introduced in 20.1.1.
email
String Email ID of the portal user. Field introduced in 20.1.1.
managed_accounts (optional)
array[ALBServicesAccount] Information about all the accounts managed by user in the customer portal. Field introduced in 20.1.1.
name (optional)
String Name of the portal user. Field introduced in 20.1.1.
phone (optional)
String Phone number of the user. Field introduced in 20.1.1.

IpReputationConfig Up

ip_reputation_file_object_expiry_duration (optional)
Integer IP reputation db file object expiry duration in days. Allowed values are 1-7. Field introduced in 20.1.1. Unit is DAYS. format: int32
ip_reputation_sync_interval (optional)
Integer IP reputation db sync interval in minutes. Allowed values are 2-1440. Field introduced in 20.1.1. Unit is MIN. format: int32

PortalFeatureOptIn Up

enable_auto_case_creation_on_se_failure (optional)
Boolean Flag to check if the user has opted in for proactive case creation on service engine failure. Field introduced in 20.1.1.
enable_auto_case_creation_on_system_failure (optional)
Boolean Flag to check if the user has opted in for proactive case creation on system failure. Field introduced in 20.1.1.
enable_auto_download_waf_signatures (optional)
Boolean Flag to check if the user has opted in for auto deployment of CRS data on controller. Field introduced in 20.1.1.
enable_ip_reputation (optional)
Boolean Flag to check if the user has opted in for automated IP reputation db sync. Field introduced in 20.1.1.
enable_waf_signatures_notifications (optional)
Boolean Flag to check if the user has opted in for notifications about the availability of new CRS data. Field introduced in 20.1.1.

ProactiveSupportDefaults Up

attach_core_dump (optional)
Boolean Opt-in to attach core dump with support case. Field introduced in 20.1.1.
attach_tech_support (optional)
Boolean Opt-in to attach tech support with support case. Field introduced in 20.1.1.
case_severity (optional)
String Case severity to be used for proactive support case creation. Field introduced in 20.1.1.

ProxyConfiguration Up

host
String Proxy hostname or IP address.
password (optional)
String Password for proxy.
port
Integer Proxy port. format: int32
username (optional)
String Username for proxy.