Cisco Crosswork Collection Service API is one of 99 APIs that Cisco Crosswork publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include CollectionService. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
10 operations
across 9 paths,
and defines 80 schemas.
It is described by OpenAPI 3.2.0, at version 4.0.
Requests are made against the base URL https://{crosswork-host}:{port}.
The identity and technical contract details declared by the specification.
gnmiPathElem
object
PathElem encodes an element of a gNMI path, along with any attributes (keys) that may be associated with it. Reference: gNMI Specification Section 2.2.2.
2 properties
collection_serviceCollectionControlStatus
object
7 properties
collection_serviceCollectionLifeCycleState
object
CollectionState aggregate an application context to a State.
3 properties
collection_serviceCollectionDataMetrics
object
2 properties
collection_serviceGetCollectionJobLifeCycleStateRequest
object
GetCollectionJobStateRequest encapsulates requests for the lifetime cycle state of associated collection jobs.
3 properties
collection_serviceSensorOutputConfig
object
Sensor Output represents output of sensor to a destination for given sensor which is a topic on a message broker or GRPC server.
3 properties
collection_serviceGetCollectionJobConfigResponse
object
3 properties
common_collection_dataGnmiSensor
object
3 properties
collection_serviceDeleteCollectionJobRequest
object
1 property
collection_serviceSensorInputConfigCommitted
object
2 properties
collection_serviceJobLifetimeType
string
- UNKNOWNTEMPORALTYPE: Invalid Lifetime - APPLICATIONMANAGED: Create and Delete of Collection job is managed by Application - CALENDARMANAGED: Create and Delet…
common_collection_dataSyslogSensor
object
3 properties
collection_serviceFilterOperator
string
- UNKNOWNOPERATOR: unknown operator - OPERATOROR: OR operator filter applied across filter list - OPERATORAND: AND operator filter applied across filter list -…
collection_serviceGetCollectionJobSummaryRequest
object
Will return all collection job operational status summary if deviceid is empty for given application context or will return on per device basis.
2 properties
common_collection_dataGNMIDeviceSetting
object
6 properties
collection_serviceGetCollectionDataMetricsRequest
object
3 properties
common_collection_dataSnmpSensor
object
2 properties
collection_serviceOutputStatus
object
4 properties
collection_serviceSensorConfigCommitted
object
SensorConfig describing cadence from input and output side along with destination.
2 properties
collection_serviceCollectionStatus
object
3 properties
collection_serviceResult
object
Result is used to convey whether an operation (individual or in a batch) has been accepted or rejected. For sync API's an error or rejection indicates failure…
2 properties
gnmiModelData
object
3 properties
collection_serviceGetCollectionJobSummaryResponse
object
3 properties
common_collection_dataDevicePackage
object
3 properties
collection_serviceCollectionState
string
- ACTIVESTATE: Object is behaving as expected - INACTIVESTATE: Object is in a bad state. - ACCEPTEDSTATE: Object is under evaluation
collection_serviceGetCollectionJobLifeCycleStateResponse
object
3 properties
collection_serviceQueryOptions
object
4 properties
collection_serviceFilter
object
2 properties
collection_serviceGetCollectionControlStatusRequest
object
3 properties
common_collection_dataSnmpYangSensor
object
1 property
collection_serviceGetCollectionControlStatusResponse
object
CollectionControlStatusDeviceResponse indicates the list of devices for which the job is successfully processed.
3 properties
common_collection_dataCliSensor
object
2 properties
collection_serviceGetCollectionJobConfigRequest
object
3 properties
collection_serviceRequestResult
string
- REJECTED: Request has been rejected - ACCEPTED: Request has been accepted for processing
collection_serviceDeviceData
object
2 properties
common_collection_dataSensorData
object
9 properties
collection_serviceKeyValueMetric
object
2 properties
collection_serviceDestination
object
Destination identifier to uniquely identify a destination Output encoding format for destination is derived from Inventory destinationid.
3 properties
collection_servicePhase
string
- ACTIVE: Request is active , Collection Job associated with app Context may be in any one of the above states - TERMINATING: Request is marked for deletion ,…
collection_serviceGetCollectionJobCountResponse
object
7 properties
collection_serviceGetCollectionDataMetricsResponse
object
3 properties
collection_serviceStatus
string
- NOTREADY: NOTREADY indicates that initial setup of the object is in progress, or being retried. - READY: READY indicates that initial setup of the object is…
collection_serviceGetIsResourceInUseResponse
object
2 properties
collection_serviceCollectionMode
object
4 properties
collection_serviceLifeCycleState
string
collection_serviceMetrics
object
1 property
collection_serviceCreateCollectionJobRequest
object
1 property
common_collection_dataMDTSensor
object
1 property
collection_serviceGetIsResourceInUseRequest
object
1 property
collection_serviceFilterField
object
2 properties
collection_serviceSensorOutputConfigCommitted
object
3 properties
common_collection_dataSnmpMib
object
2 properties
collection_serviceDeviceSet
object
Device Grouping Object , for a given request set one of either one of device grouping i.e, list of devices or a device group not both. OneOf construct is enfor…
2 properties
collection_serviceDevices
object
1 property
collection_serviceGetCollectionJobCountRequest
object
1 property
collection_serviceInputMetrics
object
3 properties
collection_serviceJobDeviceSet
object
1 property
common_collection_dataTrapSensor
object
1 property
common_collection_dataCliYangSensor
object
1 property
collection_serviceApplicationContext
object
2 properties
collection_serviceGetCollectionDataStatusRequest
object
3 properties
common_collection_dataKeyValue
object
10 properties
gnmiSubscriptionMode
string
collection_serviceCollectionJobStatus
object
8 properties
collection_serviceCreateCollectionJobResponse
object
1 property
common_collection_dataCollectionType
string
common_collection_dataSnmpOperation
string
gnmiQOSMarking
object
1 property
collection_serviceOutputMetrics
object
4 properties
collection_serviceInputStatus
object
3 properties
collection_serviceError
object
1 property
SyslogSensorPRIs
object
2 properties
gnmiPath
object
Path encodes a data tree path as a series of repeated strings, with each element of the path representing a data tree node name and the associated attributes.…
4 properties
collection_serviceGetCollectionDataStatusResponse
object
CollectionJobDeviceSetStatus indicates the list of devices for which the job is successfully processed.
3 properties
common_collection_dataTrapYangSensor
object
1 property
collection_serviceSensorInputConfig
object
SensorInputConfig represents device side collection at some cadence.
2 properties
collection_serviceCollectionDataStatus
object
2 properties
collection_serviceCollectionJobConfiguration
object
5 properties
collection_serviceDeleteCollectionJobResponse
object
1 property
collection_serviceConfigurationCommitState
string
- COMMITTED: Control config for device was successfully converged based on target state - NOTCOMMITTED: Control config for device was not successfully converge…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cisco Crosswork publishes across the network.
