Avi DebugController Object API

##CLI## ``` - debug controller - debug controller - show debug controller ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
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 /debugcontroller
  2. post /debugcontroller
  3. delete /debugcontroller/{uuid}
  4. get /debugcontroller/{uuid}
  5. patch /debugcontroller/{uuid}
  6. put /debugcontroller/{uuid}
Up
get /debugcontroller
(debugcontrollerGet)

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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

DebugControllerApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "trace_level" : "aeiou",
    "tenant_ref" : "aeiou",
    "log_level" : "aeiou",
    "name" : "aeiou",
    "sub_module" : "aeiou",
    "filters" : {
      "hs_debug_filter" : {
        "server" : "aeiou",
        "period" : 123,
        "pool" : "aeiou",
        "metric_entity" : "aeiou",
        "skip_hs_db_writes" : true,
        "entity" : "aeiou"
      },
      "alert_debug_filter" : {
        "cfg_uuid" : "aeiou",
        "alert_objid" : "aeiou",
        "alert_uuid" : "aeiou"
      },
      "metrics_debug_filter" : {
        "skip_cluster_map_check" : "aeiou",
        "metric_instance_id" : "aeiou",
        "log_first_n" : "aeiou",
        "disable_hw_training" : "aeiou",
        "obj" : "aeiou",
        "skip_metrics_db_writes" : "aeiou",
        "license_grace_period" : "aeiou",
        "entity" : "aeiou",
        "logging_freq" : "aeiou"
      },
      "se_mgr_debug_filter" : {
        "name" : "aeiou"
      },
      "mesos_metrics_debug_filter" : {
        "metrics_collection_frq" : 123,
        "metric_entity" : "aeiou",
        "mesos_slave" : "aeiou",
        "mesos_master" : "aeiou"
      },
      "cloud_connector_debug_filter" : {
        "disable_se_reboot" : true,
        "se_id" : "aeiou",
        "app_id" : "aeiou"
      },
      "state_cache_mgr_debug_filter" : {
        "pool_ref" : "aeiou",
        "vs_ref" : "aeiou"
      },
      "type" : "aeiou",
      "autoscale_mgr_debug_filter" : {
        "intelligent_autoscale_period" : 123,
        "pool_ref" : "aeiou",
        "enable_aws_autoscale_integration" : true
      },
      "vs_debug_filter" : {
        "name" : "aeiou",
        "se_uuid" : "aeiou"
      }
    },
    "uuid" : "aeiou",
    "url" : "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

200

OK DebugControllerApiResponse

401

log in failed

Up
post /debugcontroller
(debugcontrollerPost)

Consumes

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

Request body

body (required)
Body Parameter — DebugController object creation

Return type

DebugController

Example data

Content-Type: application/json
{
  "trace_level" : "aeiou",
  "tenant_ref" : "aeiou",
  "log_level" : "aeiou",
  "name" : "aeiou",
  "sub_module" : "aeiou",
  "filters" : {
    "hs_debug_filter" : {
      "server" : "aeiou",
      "period" : 123,
      "pool" : "aeiou",
      "metric_entity" : "aeiou",
      "skip_hs_db_writes" : true,
      "entity" : "aeiou"
    },
    "alert_debug_filter" : {
      "cfg_uuid" : "aeiou",
      "alert_objid" : "aeiou",
      "alert_uuid" : "aeiou"
    },
    "metrics_debug_filter" : {
      "skip_cluster_map_check" : "aeiou",
      "metric_instance_id" : "aeiou",
      "log_first_n" : "aeiou",
      "disable_hw_training" : "aeiou",
      "obj" : "aeiou",
      "skip_metrics_db_writes" : "aeiou",
      "license_grace_period" : "aeiou",
      "entity" : "aeiou",
      "logging_freq" : "aeiou"
    },
    "se_mgr_debug_filter" : {
      "name" : "aeiou"
    },
    "mesos_metrics_debug_filter" : {
      "metrics_collection_frq" : 123,
      "metric_entity" : "aeiou",
      "mesos_slave" : "aeiou",
      "mesos_master" : "aeiou"
    },
    "cloud_connector_debug_filter" : {
      "disable_se_reboot" : true,
      "se_id" : "aeiou",
      "app_id" : "aeiou"
    },
    "state_cache_mgr_debug_filter" : {
      "pool_ref" : "aeiou",
      "vs_ref" : "aeiou"
    },
    "type" : "aeiou",
    "autoscale_mgr_debug_filter" : {
      "intelligent_autoscale_period" : 123,
      "pool_ref" : "aeiou",
      "enable_aws_autoscale_integration" : true
    },
    "vs_debug_filter" : {
      "name" : "aeiou",
      "se_uuid" : "aeiou"
    }
  },
  "uuid" : "aeiou",
  "url" : "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

200

OK DebugController

401

log in failed

Up
delete /debugcontroller/{uuid}
(debugcontrollerUuidDelete)

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 /debugcontroller/{uuid}
(debugcontrollerUuidGet)

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.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

DebugController

Example data

Content-Type: application/json
{
  "trace_level" : "aeiou",
  "tenant_ref" : "aeiou",
  "log_level" : "aeiou",
  "name" : "aeiou",
  "sub_module" : "aeiou",
  "filters" : {
    "hs_debug_filter" : {
      "server" : "aeiou",
      "period" : 123,
      "pool" : "aeiou",
      "metric_entity" : "aeiou",
      "skip_hs_db_writes" : true,
      "entity" : "aeiou"
    },
    "alert_debug_filter" : {
      "cfg_uuid" : "aeiou",
      "alert_objid" : "aeiou",
      "alert_uuid" : "aeiou"
    },
    "metrics_debug_filter" : {
      "skip_cluster_map_check" : "aeiou",
      "metric_instance_id" : "aeiou",
      "log_first_n" : "aeiou",
      "disable_hw_training" : "aeiou",
      "obj" : "aeiou",
      "skip_metrics_db_writes" : "aeiou",
      "license_grace_period" : "aeiou",
      "entity" : "aeiou",
      "logging_freq" : "aeiou"
    },
    "se_mgr_debug_filter" : {
      "name" : "aeiou"
    },
    "mesos_metrics_debug_filter" : {
      "metrics_collection_frq" : 123,
      "metric_entity" : "aeiou",
      "mesos_slave" : "aeiou",
      "mesos_master" : "aeiou"
    },
    "cloud_connector_debug_filter" : {
      "disable_se_reboot" : true,
      "se_id" : "aeiou",
      "app_id" : "aeiou"
    },
    "state_cache_mgr_debug_filter" : {
      "pool_ref" : "aeiou",
      "vs_ref" : "aeiou"
    },
    "type" : "aeiou",
    "autoscale_mgr_debug_filter" : {
      "intelligent_autoscale_period" : 123,
      "pool_ref" : "aeiou",
      "enable_aws_autoscale_integration" : true
    },
    "vs_debug_filter" : {
      "name" : "aeiou",
      "se_uuid" : "aeiou"
    }
  },
  "uuid" : "aeiou",
  "url" : "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

200

OK DebugController

401

log in failed

Up
patch /debugcontroller/{uuid}
(debugcontrollerUuidPatch)

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 — DebugController object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

DebugController

Example data

Content-Type: application/json
{
  "trace_level" : "aeiou",
  "tenant_ref" : "aeiou",
  "log_level" : "aeiou",
  "name" : "aeiou",
  "sub_module" : "aeiou",
  "filters" : {
    "hs_debug_filter" : {
      "server" : "aeiou",
      "period" : 123,
      "pool" : "aeiou",
      "metric_entity" : "aeiou",
      "skip_hs_db_writes" : true,
      "entity" : "aeiou"
    },
    "alert_debug_filter" : {
      "cfg_uuid" : "aeiou",
      "alert_objid" : "aeiou",
      "alert_uuid" : "aeiou"
    },
    "metrics_debug_filter" : {
      "skip_cluster_map_check" : "aeiou",
      "metric_instance_id" : "aeiou",
      "log_first_n" : "aeiou",
      "disable_hw_training" : "aeiou",
      "obj" : "aeiou",
      "skip_metrics_db_writes" : "aeiou",
      "license_grace_period" : "aeiou",
      "entity" : "aeiou",
      "logging_freq" : "aeiou"
    },
    "se_mgr_debug_filter" : {
      "name" : "aeiou"
    },
    "mesos_metrics_debug_filter" : {
      "metrics_collection_frq" : 123,
      "metric_entity" : "aeiou",
      "mesos_slave" : "aeiou",
      "mesos_master" : "aeiou"
    },
    "cloud_connector_debug_filter" : {
      "disable_se_reboot" : true,
      "se_id" : "aeiou",
      "app_id" : "aeiou"
    },
    "state_cache_mgr_debug_filter" : {
      "pool_ref" : "aeiou",
      "vs_ref" : "aeiou"
    },
    "type" : "aeiou",
    "autoscale_mgr_debug_filter" : {
      "intelligent_autoscale_period" : 123,
      "pool_ref" : "aeiou",
      "enable_aws_autoscale_integration" : true
    },
    "vs_debug_filter" : {
      "name" : "aeiou",
      "se_uuid" : "aeiou"
    }
  },
  "uuid" : "aeiou",
  "url" : "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

200

OK DebugController

401

log in failed

Up
put /debugcontroller/{uuid}
(debugcontrollerUuidPut)

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 — DebugController object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

DebugController

Example data

Content-Type: application/json
{
  "trace_level" : "aeiou",
  "tenant_ref" : "aeiou",
  "log_level" : "aeiou",
  "name" : "aeiou",
  "sub_module" : "aeiou",
  "filters" : {
    "hs_debug_filter" : {
      "server" : "aeiou",
      "period" : 123,
      "pool" : "aeiou",
      "metric_entity" : "aeiou",
      "skip_hs_db_writes" : true,
      "entity" : "aeiou"
    },
    "alert_debug_filter" : {
      "cfg_uuid" : "aeiou",
      "alert_objid" : "aeiou",
      "alert_uuid" : "aeiou"
    },
    "metrics_debug_filter" : {
      "skip_cluster_map_check" : "aeiou",
      "metric_instance_id" : "aeiou",
      "log_first_n" : "aeiou",
      "disable_hw_training" : "aeiou",
      "obj" : "aeiou",
      "skip_metrics_db_writes" : "aeiou",
      "license_grace_period" : "aeiou",
      "entity" : "aeiou",
      "logging_freq" : "aeiou"
    },
    "se_mgr_debug_filter" : {
      "name" : "aeiou"
    },
    "mesos_metrics_debug_filter" : {
      "metrics_collection_frq" : 123,
      "metric_entity" : "aeiou",
      "mesos_slave" : "aeiou",
      "mesos_master" : "aeiou"
    },
    "cloud_connector_debug_filter" : {
      "disable_se_reboot" : true,
      "se_id" : "aeiou",
      "app_id" : "aeiou"
    },
    "state_cache_mgr_debug_filter" : {
      "pool_ref" : "aeiou",
      "vs_ref" : "aeiou"
    },
    "type" : "aeiou",
    "autoscale_mgr_debug_filter" : {
      "intelligent_autoscale_period" : 123,
      "pool_ref" : "aeiou",
      "enable_aws_autoscale_integration" : true
    },
    "vs_debug_filter" : {
      "name" : "aeiou",
      "se_uuid" : "aeiou"
    }
  },
  "uuid" : "aeiou",
  "url" : "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

200

OK DebugController

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. AlertMgrDebugFilter
  2. AutoScaleMgrDebugFilter
  3. CloudConnectorDebugFilter
  4. DebugController
  5. DebugControllerApiResponse
  6. DebugFilterUnion
  7. HSMgrDebugFilter
  8. MesosMetricsDebugFilter
  9. MetricsMgrDebugFilter
  10. SeMgrDebugFilter
  11. StateCacheMgrDebugFilter
  12. VsDebugFilter

AlertMgrDebugFilter Up

alert_objid (optional)
String filter debugs for entity uuid.
alert_uuid (optional)
String filter debugs for an alert id.
cfg_uuid (optional)
String filter debugs for an alert config.

AutoScaleMgrDebugFilter Up

enable_aws_autoscale_integration (optional)
Boolean Enable aws autoscale integration. This is an alpha feature. Field introduced in 17.1.1.
intelligent_autoscale_period (optional)
Integer period of running intelligent autoscale check. format: int32
pool_ref (optional)
String uuid of the Pool. It is a reference to an object of type Pool.

CloudConnectorDebugFilter Up

app_id (optional)
String filter debugs for an app.
disable_se_reboot (optional)
Boolean Disable SE reboot via cloud connector on HB miss.
se_id (optional)
String filter debugs for a SE.

DebugController Up

filters (optional)
DebugFilterUnion Placeholder for description of property filters of obj type DebugController field type str type object
log_level
String Enum options - LOG_LEVEL_DISABLED, LOG_LEVEL_INFO, LOG_LEVEL_WARNING, LOG_LEVEL_ERROR.
name
String Name of the object.
sub_module
String Enum options - TASK_QUEUE_DEBUG, RPC_INFRA_DEBUG, JOB_MGR_DEBUG, TRANSACTION_DEBUG, SE_AGENT_DEBUG, SE_AGENT_METRICS_DEBUG, VIRTUALSERVICE_DEBUG, RES_MGR_DEBUG, SE_MGR_DEBUG, VI_MGR_DEBUG, METRICS_MANAGER_DEBUG, METRICS_MGR_DEBUG, EVENT_API_DEBUG, HS_MGR_DEBUG, ALERT_MGR_DEBUG, AUTOSCALE_MGR_DEBUG, APIC_AGENT_DEBUG, REDIS_INFRA_DEBUG, CLOUD_CONNECTOR_DEBUG, MESOS_METRICS_DEBUG, STATECACHE_MGR_DEBUG, NSX_AGENT_DEBUG.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
trace_level
String Enum options - TRACE_LEVEL_DISABLED, TRACE_LEVEL_ERROR, TRACE_LEVEL_DEBUG, TRACE_LEVEL_DEBUG_DETAIL.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.

DebugControllerApiResponse Up

count
Integer format: int32
results

DebugFilterUnion Up

alert_debug_filter (optional)
AlertMgrDebugFilter Placeholder for description of property alert_debug_filter of obj type DebugFilterUnion field type str type object
autoscale_mgr_debug_filter (optional)
AutoScaleMgrDebugFilter Placeholder for description of property autoscale_mgr_debug_filter of obj type DebugFilterUnion field type str type object
cloud_connector_debug_filter (optional)
CloudConnectorDebugFilter Placeholder for description of property cloud_connector_debug_filter of obj type DebugFilterUnion field type str type object
hs_debug_filter (optional)
HSMgrDebugFilter Placeholder for description of property hs_debug_filter of obj type DebugFilterUnion field type str type object
mesos_metrics_debug_filter (optional)
MesosMetricsDebugFilter Placeholder for description of property mesos_metrics_debug_filter of obj type DebugFilterUnion field type str type object
metrics_debug_filter (optional)
MetricsMgrDebugFilter Placeholder for description of property metrics_debug_filter of obj type DebugFilterUnion field type str type object
se_mgr_debug_filter (optional)
SeMgrDebugFilter Placeholder for description of property se_mgr_debug_filter of obj type DebugFilterUnion field type str type object
state_cache_mgr_debug_filter (optional)
StateCacheMgrDebugFilter Placeholder for description of property state_cache_mgr_debug_filter of obj type DebugFilterUnion field type str type object
type
String Enum options - TASK_QUEUE_DEBUG, RPC_INFRA_DEBUG, JOB_MGR_DEBUG, TRANSACTION_DEBUG, SE_AGENT_DEBUG, SE_AGENT_METRICS_DEBUG, VIRTUALSERVICE_DEBUG, RES_MGR_DEBUG, SE_MGR_DEBUG, VI_MGR_DEBUG, METRICS_MANAGER_DEBUG, METRICS_MGR_DEBUG, EVENT_API_DEBUG, HS_MGR_DEBUG, ALERT_MGR_DEBUG, AUTOSCALE_MGR_DEBUG, APIC_AGENT_DEBUG, REDIS_INFRA_DEBUG, CLOUD_CONNECTOR_DEBUG, MESOS_METRICS_DEBUG, STATECACHE_MGR_DEBUG, NSX_AGENT_DEBUG.
vs_debug_filter (optional)
VsDebugFilter Placeholder for description of property vs_debug_filter of obj type DebugFilterUnion field type str type object

HSMgrDebugFilter Up

entity (optional)
String entity of HSMgrDebugFilter.
metric_entity (optional)
String Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY.
period (optional)
Integer Number of period. format: int32
pool (optional)
String pool of HSMgrDebugFilter.
server (optional)
String server of HSMgrDebugFilter.
skip_hs_db_writes (optional)
Boolean Placeholder for description of property skip_hs_db_writes of obj type HSMgrDebugFilter field type str type boolean

MesosMetricsDebugFilter Up

mesos_master (optional)
String mesos_master of MesosMetricsDebugFilter.
mesos_slave (optional)
String mesos_slave of MesosMetricsDebugFilter.
metric_entity (optional)
String Enum options - VSERVER_METRICS_ENTITY, VM_METRICS_ENTITY, SE_METRICS_ENTITY, CONTROLLER_METRICS_ENTITY, APPLICATION_METRICS_ENTITY, TENANT_METRICS_ENTITY.
metrics_collection_frq (optional)
Integer Number of metrics_collection_frq. format: int32

MetricsMgrDebugFilter Up

disable_hw_training (optional)
String disable_hw_training of MetricsMgrDebugFilter.
entity (optional)
String entity of MetricsMgrDebugFilter.
license_grace_period (optional)
String setting to reduce the grace period for license expiry in hours.
log_first_n (optional)
String log_first_n of MetricsMgrDebugFilter.
logging_freq (optional)
String logging_freq of MetricsMgrDebugFilter.
metric_instance_id (optional)
String metric_instance_id of MetricsMgrDebugFilter.
obj (optional)
String obj of MetricsMgrDebugFilter.
skip_cluster_map_check (optional)
String skip_cluster_map_check of MetricsMgrDebugFilter.
skip_metrics_db_writes (optional)
String skip_metrics_db_writes of MetricsMgrDebugFilter.

SeMgrDebugFilter Up

name (optional)
String Name of the object.

StateCacheMgrDebugFilter Up

pool_ref (optional)
String Pool UUID. It is a reference to an object of type Pool.
vs_ref (optional)
String VirtualService UUID. It is a reference to an object of type VirtualService.

VsDebugFilter Up

name (optional)
String Name of the object.
se_uuid (optional)
String Unique object identifier of se.