status#

Autogenerated API

argus_api.lib.componentadmin.v2.status.get_component_status(componentID: str, 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 status for specified component (INTERNAL)

Parameters

  • componentID (str) – Component ID

  • 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.componentadmin.v2.status.get_host_instances(host: str, limit: int = 25, offset: int = 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#

Request status for all instances on specified host (INTERNAL)

Parameters

  • host (str) – ID or name of host to request instance status for

  • limit (int) – Maximum number of results, or 0 for unlimited. Default is 25.

  • offset (int) – Skip this number of 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.componentadmin.v2.status.get_host_status(host: str, 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#

Request status for specific host (INTERNAL)

Parameters

  • host (str) – ID or name of host to request 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.componentadmin.v2.status.get_instance_status(instanceID: 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#

Request status for specific instance (INTERNAL)

Parameters

  • instanceID (int) – ID of instance to request 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.componentadmin.v2.status.get_instance_status_1(instanceID: 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#

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

argus_api.lib.componentadmin.v2.status.get_status_overview(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#

Request status overview (INTERNAL)

Parameters

  • 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.componentadmin.v2.status.get_template_status(template: str, 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#

Get template status (INTERNAL)

Parameters

  • template (str) – ID or shortname of template 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.componentadmin.v2.status.list_component_status(componentType: str = None, limit: int = 25, offset: int = 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#

List component status (INTERNAL)

Parameters

  • componentType (str) – Component type

  • limit (int) – Maximum number of results, or 0 for unlimited. Default is 25.

  • offset (int) – Skip this number of 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.componentadmin.v2.status.list_host_status(instanceState: str = None, hostState: str = None, sortBy: str = None, limit: int = 25, offset: int = 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#

Simple host status search (INTERNAL)

Parameters

  • instanceState (list) – Filter result by instance state

  • hostState (list) – Filter result by host state

  • sortBy (list) – Specify sort ordering. Default is sort by name ascending.

  • limit (int) – Maximum number of results, or 0 for unlimited. Default is 25.

  • offset (int) – Skip this number of 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.componentadmin.v2.status.list_instance_status(instanceState: str = None, limit: int = 25, offset: int = 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#

Simple instance status search (INTERNAL)

Parameters

  • instanceState (list) – Filter result by instance state

  • limit (int) – Maximum number of results, or 0 for unlimited. Default is 25.

  • offset (int) – Skip this number of 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.componentadmin.v2.status.list_template_status(limit: int = 25, offset: int = 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#

List template status, ordered by template name (INTERNAL)

Parameters

  • limit (int) – Maximum number of results, or 0 for unlimited. Default is 25.

  • offset (int) – Skip this number of 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.componentadmin.v2.status.search_component_status(componentType: str = None, componentIdentifiers: dict = 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#

Advanced component status search (INTERNAL)

Parameters

  • componentType (str) – Type of components to invoke

  • componentIdentifiers (dict) – Identifiers of components to invoke

  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.

  • limit (int) – Set this value to set max number of results. By default, result set size is 25. (default 25)

  • 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.componentadmin.v2.status.search_host_status(customer: str = None, labels: str = None, keywords: str = None, state: str = None, includeFlags: str = None, excludeFlags: str = None, subCriteria: dict = None, instanceCriteria: dict = None, offset: int = None, sortBy: str = 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#

Advanced host status search (INTERNAL)

Parameters

  • customer (list) – Filter hosts by owning customer (id or shortname).

  • labels (list) – If set, include only hosts where any of these labels are set.

  • keywords (list) – A set of keywords matched against hosts.

  • state (list) – If set, limit result to hosts in one of these states.

  • includeFlags (list) – If set, include only results where all these flags are set.

  • excludeFlags (list) – If set, exclude all results where all these flags are set.

  • subCriteria (list) – Set additional criterias (by default applied using a logical OR, unless required/excluded is set).

  • instanceCriteria (list) – Filter hosts by instance status search criteria. Will filter hosts which contain the matching instances

  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.

  • sortBy (list) – Specify sort ordering for returned host status. Default is sort by host name. (default [name])

  • limit (int) – Set this value to set max number of results. By default, result set size is 25. (default 25)

  • 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.componentadmin.v2.status.search_instance_status(customer: str = None, keywords: str = None, host: str = None, template: str = None, state: str = None, includeFlags: str = None, excludeFlags: str = None, subCriteria: dict = 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#

Advanced instance status search (INTERNAL)

Parameters

  • customer (list) – Filter instances by their hosts owning customer (id or shortname).

  • keywords (list) – A set of keywords matched against instances, or their template or host.

  • host (list) – If set, limit result to instances for any of these hosts (by id or hostname).

  • template (list) – If set, limit result to instances of any of these templates (by id or shortname)

  • state (list) – If set, limit result to instances in one of these states.

  • includeFlags (list) – If set, include only results where all these flags are set.

  • excludeFlags (list) – If set, exclude all results where all these flags are set.

  • subCriteria (list) – Set additional criterias (by default applied using a logical OR, unless required/excluded is set).

  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.

  • limit (int) – Set this value to set max number of results. By default, result set size is 25. (default 25)

  • 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.componentadmin.v2.status.update_host_status(containerID: str = None, identifiers: dict = None, state: str = None, components: dict = None, containers: dict = None, installedContainers: dict = 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#

Submit status update for a host which may also have running containers. The host will be resolved by agent using the current user. (INTERNAL)

Parameters

  • containerID (str) – ID of the currently running container

  • identifiers (dict) – Any identifiers for this instance container

  • state (str) – The state of this instance container

  • components (list) – An optional list of component updates for the root container

  • containers (list) – A set of instance container status records

  • installedContainers (list) – A set of installed instance descriptors

  • 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.componentadmin.v2.status.update_instance_status(instanceID: int, containerID: str = None, identifiers: dict = None, state: str = None, components: dict = None, runningInstanceRevision: int = None, runningTemplateRevision: int = 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#

Submit status update for a specific component. The host will be resolved by agent using the current user.The instanceID must be a valid instance for the current users host. (INTERNAL)

Parameters

  • instanceID (int) – ID of instance

  • containerID (str) – ID of the currently running container

  • identifiers (dict) – Any identifiers for this instance container

  • state (str) – The state of this instance container

  • components (list) – An optional list of component updates for the root container

  • runningInstanceRevision (int) – The instance revision of the running container

  • runningTemplateRevision (int) – The template revision of the running container

  • 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