/mgmt/status/default/VlanInterfaceStatus2 GET

Use the HTTP GET method with the /mgmt/status/default/VlanInterfaceStatus2 resource to retrieve status for VLAN interfaces on the appliance.

Resource URL
Request headers
Request body format
Security requirements
Response status codes
Response headers
Response body format
Examples

Resource URL

https://host:port/mgmt/status/default/VlanInterfaceStatus2

Where port is 5554 by default.

Request headers

The following header must be sent with the request:

Authorization: This header must be sent to perform authentication.

Request body format

None.

Security requirements

The caller must be authenticated as an appliance user with sufficient authority. For more information about security, see Types of user and how they are authenticated and User authorization, credential mapping, and access profiles.

Response status codes

200: Status information retrieved successfully.
400: Invalid data provided.
401: Not authenticated.; The caller must be authenticated as an appliance user. See Types of user and how they are authenticated for more information.
403: Not authorized.; The caller is authenticated but does not the authority to perform this action. See User authorization, credential mapping, and access profiles for more information.

Response headers

Content-Type: This header is returned with a value of application/json.

Response body format

The response is in JSON format. The response includes information about VLAN interfaces. Each object contains the following fields:

Name: String.; The name of the interface in the system kernel.
MgmtName: String.; The name of the interface in the configuration.
InterfaceIndex: Integer.; The SNMP ifIndex value of the row in the SNMP ifTable for the VLAN interface.
OnIfIndex: Integer.; The SNMP ifIndex of the parent interface of the VLAN interface.
OnIfName: String.; The name of the parent interface of the VLAN interface.
VlanIdentifier: String.; The VLAN identifier that uniquely identifies the VLAN interface on its associated physical Ethernet network.

Examples

The following example requests information about VLAN interfaces on the appliance.

The following URL is used with the HTTP GET method:

https://localhost:5554/mgmt/status/default/VlanInterfaceStatus2

The following listing shows an example received response:

{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/VlanInterfaceStatus2"
    },
    "doc": {
      "href": "/mgmt/docs/status/VlanInterfaceStatus2"
    }
  },
  "result": "No status retrieved."
}