host#

Autogenerated API

argus_api.lib.configurationadmin.v1.host.add_comment(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#

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

argus_api.lib.configurationadmin.v1.host.add_host_comment(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#

Add a comment to configuration host (INTERNAL)

Parameters

  • id (int) – ID of host to comment

  • 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.configurationadmin.v1.host.configure_host_monitoring(host: str, enabled: bool = None, daytimeOnly: bool = None, comment: 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#

Configure monitoring of configuration host. This operation does not add a new revision. (INTERNAL)

Parameters

  • host (str) – ID or hostname of host to configure monitoring for

  • enabled (bool) – If set, enable or disable monitoring on this host.

  • daytimeOnly (bool) – If set, enable or disable the DAYTIME monitoring flag for this host. If monitoring is disabled, this flag has no effect.

  • comment (str) – Add a comment to the host object. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • 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.configurationadmin.v1.host.create_2(name: str = None, information: str = None, properties: dict = None, agentUser: str = None, labels: str = None, customer: str = None, preprod: bool = None, daytimeMonitored: bool = 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 : create_2 is an alias for create_host. Exists only for backward compatibility - do not use - use create_host instead.

argus_api.lib.configurationadmin.v1.host.create_host(name: str = None, information: str = None, properties: dict = None, agentUser: str = None, labels: str = None, customer: str = None, preprod: bool = None, daytimeMonitored: bool = 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#

Create new configuration host (INTERNAL)

Parameters

  • name (str) – [a-zA-Z0-9_:\-.]*

  • information (str) – [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • properties (dict) –

  • agentUser (str) – Name or ID of the agent user to associate to this host.

  • labels (list) – Labels to add to this host

  • customer (str) – ID or shortname of customer to bind this host to. If not set, this host will not be bound to a customer.

  • preprod (bool) – If true, mark this host as a PREPROD host. (default false)

  • daytimeMonitored (bool) – If true, mark this host as a DAYTIME_MONITORED host. (default false)

  • 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.configurationadmin.v1.host.delete_1(id: int, deleteInstances: bool = 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 : delete_1 is an alias for delete_host. Exists only for backward compatibility - do not use - use delete_host instead.

argus_api.lib.configurationadmin.v1.host.delete_host(id: int, deleteInstances: bool = 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#

Delete configuration host (INTERNAL)

Parameters

  • id (int) – ID of host to delete

  • deleteInstances (bool) – If true, force deletion of instances for this host first

  • 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.configurationadmin.v1.host.disable_host_monitoring(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#

Disable monitoring of configuration host. This endpoint is deprecated, use PUT /host/{id}/monitoring instead. (INTERNAL)

Parameters

  • id (int) – ID of host to disable monitoring on

  • 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.configurationadmin.v1.host.disable_monitoring(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#

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

argus_api.lib.configurationadmin.v1.host.duplicate_1(sourceID: 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 : duplicate_1 is an alias for duplicate_host. Exists only for backward compatibility - do not use - use duplicate_host instead.

argus_api.lib.configurationadmin.v1.host.duplicate_2(hostID: 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 : duplicate_2 is an alias for setup_default_configuration. Exists only for backward compatibility - do not use - use setup_default_configuration instead.

argus_api.lib.configurationadmin.v1.host.duplicate_host(sourceID: 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#

Duplicate a configuration host (INTERNAL)

Parameters

  • sourceID (int) – ID of host to duplicate

  • 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.configurationadmin.v1.host.enable_host_monitoring(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#

Enable monitoring of configuration host. This endpoint is deprecated, use PUT /host/{id}/monitoring instead. (INTERNAL)

Parameters

  • id (int) – ID of host to enable monitoring on

  • 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.configurationadmin.v1.host.enable_monitoring(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#

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

argus_api.lib.configurationadmin.v1.host.list_2(search: str = None, orderDesc: bool = None, limit: int = 25, orderBy: str = 'name', includeComments: bool = None, includeDeleted: bool = None, 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#

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

argus_api.lib.configurationadmin.v1.host.list_hosts(search: str = None, orderDesc: bool = None, limit: int = 25, orderBy: str = 'name', includeComments: bool = None, includeDeleted: bool = None, 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 configuration hosts (INTERNAL)

Parameters

  • search (str) – Limit results to hosts matching this searchstring

  • orderDesc (bool) – Sort results descending

  • limit (int) – Limit results

  • orderBy (str) – Sort results

  • includeComments (bool) – Include comments in output

  • includeDeleted (bool) – Include deleted hosts in results

  • offset (int) – Offset 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.configurationadmin.v1.host.schedule_host_monitoring(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#

Schedule downtime for configuration host (INTERNAL)

Parameters

  • id (int) – ID of host to schedule downtime 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.configurationadmin.v1.host.schedule_monitoring(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#

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

argus_api.lib.configurationadmin.v1.host.search_2(limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, keywords: str = None, agentUser: str = None, customer: str = None, labels: str = None, host: str = None, inDowntime: bool = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, includeComments: bool = None, includeProperties: bool = True, 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 : search_2 is an alias for search_hosts. Exists only for backward compatibility - do not use - use search_hosts instead.

argus_api.lib.configurationadmin.v1.host.search_hosts(limit: int = None, offset: int = None, includeDeleted: bool = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, keywords: str = None, agentUser: str = None, customer: str = None, labels: str = None, host: str = None, inDowntime: bool = None, sortBy: str = None, includeFlags: str = None, excludeFlags: str = None, includeComments: bool = None, includeProperties: bool = True, 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 configuration hosts (INTERNAL)

Parameters

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.

  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).

  • keywords (list) – If set, filter hosts matching these keywords.

  • agentUser (list) – If set, limit the search result to hosts which are bound to these agents (id or username)

  • customer (list) – If set, limit the search result to hosts which are bound to these customers (id or username)

  • labels (list) – If set, limit the search result to hosts having any of these labels

  • host (list) – If set, filter hosts by ID or hostname.

  • inDowntime (bool) – If true, only return hosts which are in scheduled downtime. If false, exclude. If not set, do not filter.

  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).

  • includeFlags (list) – Only include objects which have includeFlags set.

  • excludeFlags (list) – Exclude objects which have excludeFlags set.

  • includeComments (bool) – If true, include comments on returned host configuration objects (default false)

  • includeProperties (bool) – If true, include properties on returned host configuration objects (default true)

  • 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.configurationadmin.v1.host.setup_default_configuration(hostID: 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#

Create default instances on configuration host (INTERNAL)

Parameters

  • hostID (int) – ID of host to add instances to

  • 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.configurationadmin.v1.host.update_1(hostID: int, id: int = None, name: str = None, information: str = None, properties: dict = None, agentUser: str = None, preprod: bool = None, daytimeMonitored: bool = None, setLabels: str = None, addLabels: str = None, removeLabels: 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 : update_1 is an alias for update_host. Exists only for backward compatibility - do not use - use update_host instead.

argus_api.lib.configurationadmin.v1.host.update_host(hostID: int, id: int = None, name: str = None, information: str = None, properties: dict = None, agentUser: str = None, preprod: bool = None, daytimeMonitored: bool = None, setLabels: str = None, addLabels: str = None, removeLabels: 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#

Update configuration host (INTERNAL)

Parameters

  • hostID (int) – ID of host to update

  • id (int) –

  • name (str) – [a-zA-Z0-9_:\-.]*

  • information (str) – [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • properties (dict) –

  • agentUser (str) – Name or ID of the agent user to associate to this host. If not set, do not change.

  • preprod (bool) – If set, change the PREPROD flag on this host

  • daytimeMonitored (bool) – If set, change the DAYTIME_MONITORED flag on this host

  • setLabels (list) – Labels to set on this host (overwrite existing)

  • addLabels (list) – Labels to add to this host (in addition to existing, will ignore existing labels)

  • removeLabels (list) – Labels to remove from this host (will ignore labels not set)

  • 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.configurationadmin.v1.host.update_host_properties(id: int, properties: 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#

Update configuration host properties (INTERNAL)

Parameters

  • id (int) – ID of the host to update properties on

  • properties (dict) – The host properties to update to, null value will clear the property

  • 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.configurationadmin.v1.host.view(idOrHostName: 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#

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

argus_api.lib.configurationadmin.v1.host.view_host(idOrHostName: 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 configuration host (INTERNAL)

Parameters

  • idOrHostName (str) – ID of host to fetch

  • 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