POST /qni/hosts/{host_id}/configs/{id}

Edit online

Updates the configuration of a QNI host. You cannot use this endpoint to update a host that is a part of a QNI stack. Use the QNI Stacking API instead.

Updates the configuration of a QNI host. You cannot use this endpoint to update a host that is a part of a QNI stack. Use the QNI Stacking API instead. Configuration should contain the following fields:
  • id - Required - Number - The ID of the QNI configuration. Always equals 1 because QNI host has only one configuration.
  • host_id - Required - Number - The ID of the QNI host.
  • inspection_level - Optional - Enumeration - 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 Flows levels does, but it also scans and inspects the content of the files that it finds.
    • DEFAULT - The QNI host uses the globally-set inspection level setting.
  • raw_payload - Optional - Long - The maximum amount of data (bytes) that the QFlow Collector is set to capture and retain in the flow payload. Possible values are:
    • -1: The QNI host is set to use the globally-set raw payload setting.
    • 0: Turn the payload off.
    • 1 - 32768: The number of bytes.
  • ports - Optional - Array - The updated port configuration. Each port has the following fields:
    • port_id - Required - Number - The ID of the port.
    • type - Required - Enumeration - The mode that the port is used in. The possible values are RECEIVE, TRANSMIT.
    • source_port_id - Optional - Number - The ID of the port that re-transmits the traffic. Required only if the port type is TRANSMIT.
Table 1. POST /qni/hosts/{host_id}/configs/{id} resource details
MIME Type

application/json

Table 2. POST /qni/hosts/{host_id}/configs/{id} request parameter details
Parameter Type Optionality Data Type MIME Type Description

host_id

path

Required

Number (Integer)

text/plain

Long The ID of the QNI host.

id

path

Required

Number (Integer)

text/plain

The ID of the QNI Configuration.

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/hosts/{host_id}/configs/{id} request body details
Parameter Data Type MIME Type Description Sample

qni_configuration

Object

application/json

The updated QNI Configuration (see above for more details).

{ "host_id": 42, "id": 42, "inspection_level": "String <one of: BASIC, ADVANCED, ENRICHED, DEFAULT>", "ports": [ { "id": 42, "source_port_id": 42, "type": "String <one of: RECEIVE, TRANSMIT>" } ], "raw_payload": 42 }
Table 4. POST /qni/hosts/{host_id}/configs/{id} response codes
HTTP Response Code Unique Code Description

200

QNI Configuration has been successfully updated.

404

44101

The QNI host ID does not exist.

404

44102

QNI Configuration ID does not exist.

422

44120

The QNI host ID is less than or equal to 0.

422

44122

Invalid number of ports listed.

422

44123

Port ID field is missing.

422

44124

Port ID is invalid.

422

44125

Two or more ports have the same ID.

422

44126

Source port ID field is missing.

422

44127

Source port ID is invalid.

422

44128

Source port is invalid. The type for the selected source port must be RECEIVE.

422

44129

Port type is invalid.

422

44130

The QNI host is part of a QNI Stack. You cannot configure the host individually.

422

44131

Inspection level is invalid.

422

44132

Raw payload value is invalid.

500

44110

An internal server error occurred while processing a request.

Response Description

The updated QNI configuration object representing a staged configuration of a QNI host.
  • id - Number - ID of the QNI Configuration. Always equals 1 because QNI host has only one configuration.
  • host_id - Number - ID of the QNI host.
  • inspection_level - Enumeration - 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 Flows levels does, but it also scans and inspects the content of the files that it finds.
    • DEFAULT - The QNI host uses the globally-set inspection level setting.
  • raw_payload - Long - The maximum amount of data (bytes) that the QFlow Collector is set to capture and retain in the flow payload. Possible values are:
    • -1: The QNI host is set to use the globally-set raw payload setting.
    • 0: Turn the payload off.
    • 1 - 32768: The number of bytes.
  • ports - Array - Array of configured network card ports. Each port has the following fields:
    • port_id - Number - The ID of the port.
    • type - Enumeration - The mode that the port is used in. The possible values are RECEIVE, TRANSMIT. RECEIVE type indicates the port is configured to receive traffic. TRANSMIT type indicates the port is transmitting traffic duplicated from another port.
    • source_port_id - Number - The ID of the port the that re-transmits the traffic. Only populated if the port type is TRANSMIT.

Response Sample


{
    "host_id": 42,
    "id": 42,
    "inspection_level": "String <one of: BASIC, ADVANCED, ENRICHED, DEFAULT>",
    "ports": [
        {
            "id": 42,
            "source_port_id": 42,
            "type": "String <one of: RECEIVE, TRANSMIT>"
        }
    ],
    "raw_payload": 42
}