Get Switches Aggregation Details

View Switch

View Switch information. Note: this set of endpoints is used to view operational data. They don't provide the means to manage configuration.

Operations

Export Switch InventoryDeprecated

Request

Export the list of switches belong to the tenant.

Body

required

multiSortFieldsArray of strings

matchFieldsArray of objects(MatchFieldDto)

rangeFilterobject(RangeFilterDto)

rangeDateFilterobject(RangeFilterDto)

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

sortFieldstring

sortOrderstring

pageinteger(int32)

pageByDateobject

pageSizeinteger(int32)

fieldsArray of stringsunique

searchTargetFieldsArray of strings

searchStringstring

filtersobject

mustHaveFieldsArray of strings

mustNotHaveFieldsArray of strings

termFieldobject(TermFieldDto)

termsobject

existsstring

groupBystring

{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

successful operation

Body

object(StreamingResponseBody)

Response

{}

Get PortsDeprecated

Request

Get a list of parameters for the switch's ports.

Body

required

multiSortFieldsArray of strings

matchFieldsArray of objects(MatchFieldDto)

rangeFilterobject(RangeFilterDto)

rangeDateFilterobject(RangeFilterDto)

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

sortFieldstring

sortOrderstring

pageinteger(int32)

pageByDateobject

pageSizeinteger(int32)

fieldsArray of stringsunique

searchTargetFieldsArray of strings

searchStringstring

filtersobject

mustHaveFieldsArray of strings

mustNotHaveFieldsArray of strings

termFieldobject(TermFieldDto)

termsobject

existsstring

groupBystring

{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

Successful operation

Body

fieldsArray of stringsunique

totalCountinteger(int64)

pageinteger(int32)

objectIdstring

dataArray of objects(SwitchPortDto)

errorMessagestring

subsequentQueriesArray of objects(SubsequentQuery)

Response

{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}

Get Switch ClientsDeprecated

Request

Get a list of switch clients (i.e., end-user devices).

Body

required

multiSortFieldsArray of strings

matchFieldsArray of objects(MatchFieldDto)

rangeFilterobject(RangeFilterDto)

rangeDateFilterobject(RangeFilterDto)

mustNotMatchFieldArray of objects(MustNotMatchFieldDto)

sortFieldstring

sortOrderstring

pageinteger(int32)

pageByDateobject

pageSizeinteger(int32)

fieldsArray of stringsunique

searchTargetFieldsArray of strings

searchStringstring

filtersobject

mustHaveFieldsArray of strings

mustNotHaveFieldsArray of strings

termFieldobject(TermFieldDto)

termsobject

existsstring

groupBystring

{
  "multiSortFields": [
    "string"
  ],
  "matchFields": [
    { … }
  ],
  "rangeFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "rangeDateFilter": {
    "field": "string",
    "gte": 0,
    "lte": 0,
    "lt": 0
  },
  "mustNotMatchField": [
    { … }
  ],
  "sortField": "string",
  "sortOrder": "string",
  "page": 0,
  "pageByDate": {
    "value": "string",
    "key": "string"
  },
  "pageSize": 0,
  "fields": [
    "string"
  ],
  "searchTargetFields": [
    "string"
  ],
  "searchString": "string",
  "filters": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "mustHaveFields": [
    "string"
  ],
  "mustNotHaveFields": [
    "string"
  ],
  "termField": {
    "field": "string",
    "value": "string"
  },
  "terms": {
    "property1": [ … ],
    "property2": [ … ]
  },
  "exists": "string",
  "groupBy": "string"
}

Responses

Successful operation

Body

fieldsArray of stringsunique

totalCountinteger(int64)

pageinteger(int32)

objectIdstring

dataArray of objects(SwitchClientDto)

errorMessagestring

subsequentQueriesArray of objects(SubsequentQuery)

Response

{
  "fields": [
    "string"
  ],
  "totalCount": 0,
  "page": 0,
  "objectId": "string",
  "data": [
    { … }
  ],
  "errorMessage": "string",
  "subsequentQueries": [
    { … }
  ]
}