Developer Documentation
ADM NITRO APIs

vwan_event

June 20, 2023
Contributed by: 
C

Configuration for VWAN EVENT resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
id Read-write Id is system generated key for all the events.
source Read-only Source.
wan_link_state Read-only Internal Event ID used in the source device..
virtual_path Read-only Operation Type.
status_message Read-only status_message.
rpt_sample_time Read-only Event Time.
virtual_path_state Read-only virtual_path_state.
message Read-only VWAN Event_Message.
host_name Read-only Assign hostname to managed device, if this is not provided, name will be set as host name .
type Read-only type.
category Read-only Category of VWAN Event.
severity Read-only Severity of Vwan Event.
wan_link Read-only WAN Link.

Operations

(click to see Properties )

  • GET (ALL)
  • GET

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note: * Mandatory parameters are marked in red and placeholder content is marked in green

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/vwan_event Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/vwan_event ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of vwan_event resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/vwan_event ?pagesize=#no;pageno=#no Use this query-parameter to get the vwan_event resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/vwan_event ?count=yes Use this query-parameter to get the count of vwan_event resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "vwan_event":[{
"source":<String_value>,
"wan_link_state":<String_value>,
"virtual_path":<String_value>,
"status_message":<String_value>,
"rpt_sample_time":<Double_value>,
"virtual_path_state":<String_value>,
"message":<String_value>,
"host_name":<String_value>,
"type":<String_value>,
"id":<String_value>,
"category":<String_value>,
"severity":<String_value>,
"wan_link":<String_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/vwan_event/id_value<String> HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "vwan_event":[{
"source":<String_value>,
"wan_link_state":<String_value>,
"virtual_path":<String_value>,
"status_message":<String_value>,
"rpt_sample_time":<Double_value>,
"virtual_path_state":<String_value>,
"message":<String_value>,
"host_name":<String_value>,
"type":<String_value>,
"id":<String_value>,
"category":<String_value>,
"severity":<String_value>,
"wan_link":<String_value>}]}

<!--NeedCopy-->
vwan_event
June 20, 2023
Contributed by: 
C
June 20, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.