4.6.1. Dashboards and discovery cycles¶
API for working with dashboards and discovery lifecycle.
-
class
axonius_api_client.api.system.dashboard.
DiscoverPhase
(raw)[source]¶ Bases:
axonius_api_client.data.PropsData
Pass.
- Parameters
raw (
dict
) –
-
property
progress
¶ Pass.
- Return type
-
__init__
(raw)¶ Initialize self. See help(type(self)) for accurate signature.
- Parameters
raw (
dict
) –
-
__str__
()¶ Pass.
-
static
_human_key
(key)¶ Pass.
-
classmethod
get_fields
()¶ Get a list of fields defined for current this dataclass object.
- Return type
-
replace
(**kwargs)¶ Pass.
- Return type
-
class
axonius_api_client.api.system.dashboard.
DiscoverData
(raw, adapters=<factory>)[source]¶ Bases:
axonius_api_client.data.PropsData
Pass.
- Parameters
raw (
dict
) –adapters (
typing.List
[dict
]) –
-
property
last_run_finish_date
¶ Pass.
- Return type
-
property
last_run_start_date
¶ Pass.
- Return type
-
property
current_run_duration_in_minutes
¶ Pass.
- Return type
-
property
last_run_duration_in_minutes
¶ Pass.
- Return type
-
property
last_run_minutes_ago
¶ Pass.
- Return type
-
property
next_run_start_date
¶ Pass.
- Return type
-
property
progress
¶ Pass.
- Return type
-
property
phases
¶ Pass.
-
__init__
(raw, adapters=<factory>)¶ Initialize self. See help(type(self)) for accurate signature.
- Parameters
raw (
dict
) –adapters (
typing.List
[dict
]) –
-
__str__
()¶ Pass.
-
static
_human_key
(key)¶ Pass.
-
classmethod
get_fields
()¶ Get a list of fields defined for current this dataclass object.
- Return type
-
replace
(**kwargs)¶ Pass.
- Return type
-
to_str_properties
()¶ Pass.
- Return type
-
class
axonius_api_client.api.system.dashboard.
Dashboard
(auth, **kwargs)[source]¶ Bases:
axonius_api_client.api.mixins.ModelMixins
API for working with dashboards and discovery lifecycle.
Examples
Get discover lifecycle metadata:
get()
See if a lifecycle is currently running:
is_running()
Start a discover lifecycle:
start()
Stop a discover lifecycle:
stop()
- Parameters
auth (
axonius_api_client.auth.models.Model
) –
-
get
()[source]¶ Get lifecycle metadata.
Examples
Create a
client
usingaxonius_api_client.connect.Connect
>>> data = client.dashboard.get() >>> data.next_run_starts_in_minutes 551 >>> data.is_running False
-
property
is_running
¶ Check if discovery cycle is running.
Examples
Create a
client
usingaxonius_api_client.connect.Connect
>>> data = client.dashboard.is_running False
- Return type
-
start
()[source]¶ Start a discovery cycle if one is not running.
Examples
Create a
client
usingaxonius_api_client.connect.Connect
>>> data = client.dashboard.start() >>> data.is_running True >>> j(data['phases_pending']) [ "Fetch_Devices", "Fetch_Scanners", "Clean_Devices", "Pre_Correlation", "Run_Correlations", "Post_Correlation", "Run_Queries", "Save_Historical" ] >>> j(data['phases_done']) []
-
stop
()[source]¶ Stop a discovery cycle if one is running.
Examples
Create a
client
usingaxonius_api_client.connect.Connect
>>> data = client.dashboard.start() >>> data.is_running True
-
_get
()[source]¶ Direct API method to get discovery cycle metadata.
- Return type
axonius_api_client.api.json_api.lifecycle.Lifecycle
-
__init__
(auth, **kwargs)¶ Mixins for API Models.
- Parameters
auth (
axonius_api_client.auth.models.Model
) – object to use for auth and sending API requests**kwargs – passed to
_init()
-
LOG
: logging.Logger¶ Logger for this object.
-
auth
¶ axonius_api_client.auth.models.Mixins
authentication object.
-
http
¶ axonius_api_client.http.Http
client to use to send requests,