status#

Autogenerated API

argus_api.lib.sensors.v1.status.find_sensors(limit: int = None, offset: int = None, includeDeleted: bool = None, customerID: int = None, keywords: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, customer: str = None, excludeReportingSensors: bool = None, excludeSensorsInScheduledDowntime: bool = None, excludeSensorsInReportingCluster: bool = None, lastAgentHost: str = None, startTimestamp: int = None, endTimestamp: int = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, sensorID: int = None, locationName: str = None, applicationName: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

DEPRECATED : find_sensors is an alias for search_sensor_status. Exists only for backward compatibility - do not use - use search_sensor_status instead.

argus_api.lib.sensors.v1.status.get_sensor_status_by_status(id: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Fetch sensor status by ID (INTERNAL)

Parameters
  • id (int) – ID of sensor to fetch status for

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.sensors.v1.status.list_sensor_status(customerID: int = None, applicationName: str = None, keywords: str = None, offset: int = None, limit: int = 25, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

List sensor status (INTERNAL)

Parameters
  • customerID (list) – Limit search to these customer IDs

  • applicationName (list) – Limit search to these applications by name

  • keywords (list) – Limit search by sensor hostname or IP address

  • offset (int) – Offset results

  • limit (int) – Limit results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.sensors.v1.status.list_sensors(customerID: int = None, applicationName: str = None, keywords: str = None, offset: int = None, limit: int = 25, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

DEPRECATED : list_sensors is an alias for list_sensor_status. Exists only for backward compatibility - do not use - use list_sensor_status instead.

argus_api.lib.sensors.v1.status.search_sensor_status(limit: int = None, offset: int = None, includeDeleted: bool = None, customerID: int = None, keywords: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, customer: str = None, excludeReportingSensors: bool = None, excludeSensorsInScheduledDowntime: bool = None, excludeSensorsInReportingCluster: bool = None, lastAgentHost: str = None, startTimestamp: int = None, endTimestamp: int = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, sensorID: int = None, locationName: str = None, applicationName: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Search sensor status (INTERNAL)

Parameters
  • limit (int) – Limit results

  • offset (int) – Offset results

  • includeDeleted (bool) – Also include deleted objects (where implemented)

  • customerID (list) – Limit result to objects belonging to these customers

  • keywords (list) – Search for sensors matching these hostnames or IP-addresses

  • keywordMatchStrategy (str) – Defines how strictly different keywords should be matched (default match any keywords) (default any)

  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (defaults to all supported fields) (default all)

  • customer (list) – Search for sensors belonging to customers identified by their ID or shortname

  • excludeReportingSensors (bool) – DEPRECATED: Use exclude flags

  • excludeSensorsInScheduledDowntime (bool) – DEPRECATED: Use exclude flags

  • excludeSensorsInReportingCluster (bool) – DEPRECATED: Use exclude flags

  • lastAgentHost (str) – Include sensors where lastAgentHost matches this string (entire/partial)

  • startTimestamp (int) – Search objects from this timestamp

  • endTimestamp (int) – Search objects until this timestamp

  • sortBy (list) – Order results by these properties (prefix with - to sort descending)

  • includeFlags (list) – Search objects with these flags set

  • excludeFlags (list) – Exclude objects with these flags set

  • sensorID (list) – Search for specific sensors by ID

  • locationName (list) – Search for sensors bound to any of these locations

  • applicationName (list) – Search for sensors by application type

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON