How to Use this Reference¶

Specification Table¶

The specification table provides the following information about the resource:

URI

The URI template that can be used to access a representation of instances of this object. The template format is the same as that defined in RFC 6570.

Type

Indicates what type of resource it is. For further information about resource types, see Resources.

Object Key(s)

The object key is the unique identifier for each instance of this object. It is typically either the name or ID of the object. It is used to identify the resource in the JSON schema. You cannot change the value associated with a resource’s object key. You must instead create a new resource with a different value for the object key.

Resource Name

This is the name of the object, not the instance of that object. It is used to identify the object in the ACOS device’s schema, in URI calls, and throughout the reference entry for this object.

List of Resources

If the object is a list type object (see Resources for details), this is the resource name that will be used to access the list of all configured instances of this object.

Schema

You can click this link to see the JSON schema for this object. The schema includes all information about the object. The following key:value pairs are of particular importance:

• id - contains the URI template of the object
• properties - contains all of the accessible attributes of the object. These are also listed on the reference page for the object. Each property contains type and/or format of the property, its minimum and maximum values or length, a description and whether it is optional or required.
• object-keys - contains the object key, as described above
• required - lists all properties of this object which are required when configuring the object via the aXAPI.

Operations Allowed¶

The operations table lists all supported operations for instances of this object. For each operation, it lists the HTTP method and URI template that are used to execute the operation.

The payload makes it clear whether the JSON payload contains the list of this type of object or the attributes of an individual instance of the object.

For information about aXAPIv3 operations, see Operations.

Children¶

This table lists the children of the current resource. It also lists the type and endpoint URI of each child object. Click on the object’s name to see its reference entry.

Stats Data¶

This table lists all counters available for the object. Each row displays the name of the object in the JSON schema. The table also displays the size of the counter and a brief description of what it represents.

There may be additional statistics tables, depending on how many different categories of statistics are allowed for this resource.

Operational Data¶

This table lists any operational data attributes by name, and describes what they represent. Many objects will contain the “state” attribute, which specifies whether the object is Up or Down.

Some resources may contain session information or current mappings, such as a dynamically assigned IP or MAC address.

Attributes¶

This section describes each of the objects accessible attributes. In the JSON payload, the name of the attribute will be the key, and the value will either be the value you specify (POST or PUT methods) or the value currently configured on this object on the ACOS device (GET method)

Each listing will provide information about the attribute:

Description

Describes the ACOS configuration feature that this attribute represents.

Supported Values

Lists the supported values for boolean attributes.

Range

Specifies the range of accepted integers for number attributes.

Default

Describes the default configuration this attribute that will remain in effect unless it is directly configured.

Dependency

Specifies whether there are any other parameters that are required before this parameter can be configured.

Mutual Exclusion

Indicates other attributes that cannot be configured if this attribute is configured.

Mandatory

Indicates whether or not this attribute is mandatory to configuring the object on the ACOS device.

Reference Object

Includes a link to an object that must be configured before this parameter can be applied or included.

Type

States what type of value the attribute requires. The following table shows the supported field types.