POST /qni/stacking/stacks/{stack_id}

Updates a QNI stack, as specified by the stack ID.

Updates a QNI stack, as specified by the stack ID.

Table 1. POST /qni/stacking/stacks/{stack_id} resource details
MIME Type

application/json

Table 2. POST /qni/stacking/stacks/{stack_id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

stack_id

path

Required

Number (Integer)

text/plain

null

fields

header

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. POST /qni/stacking/stacks/{stack_id} request body details
Parameter Data Type MIME Type Description Sample

stack

Object

application/json

null

{ "hosts": [ { "host_id": 42, "host_ip": "String", "primary": true } ], "inspection_level": "String <one of: BASIC, ADVANCED, ENRICHED, DEFAULT>", "name": "String", "ports_type": "String <one of: IN_4, IN_2_OUT_2, IN_1_OUT_1, IN_1_OUT_3, IN_3_OUT_1>", "raw_payload": 42, "stack_id": 42 }

Table 4. POST /qni/stacking/stacks/{stack_id} response codes
HTTP Response Code Unique Code Description

200

The QNI stack has been updated.

404

1002

The stack ID is not found.

422

44131

The inspection level is invalid.

422

44132

The raw payload value is invalid.

422

3830131

The host is not available for stacking.

422

3830134

The stack must include a minimum of 1 host.

422

3830135

The stack exceeds the maximum number of hosts.

422

3830136

The host IP address does not match the host ID.

422

3830137

Two or more hosts in the stack have the same IP address.

422

3830138

One host must be declared as the primary host.

422

3830139

The stack can have only 1 host defined as the primary.

422

3830132

The stack name must begin with a letter.

422

3830140

Specify the stack name.

422

3830141

The stack name already exists. The stack name must be unique.

422

3830133

The port type is invalid.

500

1020

An error occurred attempting to update QNI stack.

Response Description

A QNI stack. The QNI stack contains the following fields:
  • stack_id - Long - The ID of the QNI stack.
  • hosts - List<Host> - The list of the QNI managed hosts in the stack.
  • name - String - The name of the QNI stack.
  • ports_type - enum - Port configuration type for the QNI stack. The possible values are:
    • IN_4
    • IN_2_OUT_2
    • IN_1_OUT_1
    • IN_1_OUT_3
    • IN_3_OUT_1
  • inspection_level - Optional - Enumeration - The depth of content inspection. The possible values are:
    • BASIC - Lowest level of inspection. Flows are detected by 5-tuple, and the number of bytes and packets that are flowing in each direction are counted.
    • ENRICHED - Each flow is identified and inspected by one of the protocol or domain inspectors. The inspection can generate many kinds of attributes.
    • ADVANCED - The highest level of inspection. It does everything that the Enriched level does, but it also scans and inspects the content of the files that it finds.
    • DEFAULT - Indicates that the QNI host is configured to use the globally-set inspection level.
  • raw_payload - Optional - Long - The maximum amount of data (Bytes) that the QFlow Collector captures and retains in the flow payload. The possible values are:
    • -1: The QNI host is set to use the globally-set raw payload setting
    • 0: Turn off the payload
    • 1 - 32768: Number of bytes

Response Sample


{
    "hosts": [
        {
            "host_id": 42,
            "host_ip": "String",
            "primary": true
        }
    ],
    "inspection_level": "String <one of: BASIC, ADVANCED, ENRICHED, DEFAULT>",
    "name": "String",
    "ports_type": "String <one of: IN_4, IN_2_OUT_2, IN_1_OUT_1, IN_1_OUT_3, IN_3_OUT_1>",
    "raw_payload": 42,
    "stack_id": 42
}