diff --git a/docs/index.rst b/docs/index.rst index d1b8ac7..6c938e2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst |MIT license| |made-with-python| |PyPi| |github| |doc-status| |Downloads| Axonius API Client ################################################################## +.. include:: /main/deprecation_banner.rst + axonius-api-client is an API client for `Axonius`_. You can :doc:`Install it
` today! It provides: diff --git a/docs/main/axtokens.rst b/docs/main/axtokens.rst index 0b066a0..ed7a87a 100644 --- a/docs/main/axtokens.rst +++ b/docs/main/axtokens.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst .. _axtokens: API Key and Secret ######################### +.. include:: /main/deprecation_banner.rst + The API Key and Secret for an Axonius user is available from the :blue:`My Account` page. You can get to the :blue:`My Account` page by clicking the gear icon in the left hand diff --git a/docs/main/contributing.rst b/docs/main/contributing.rst index c53e5c7..0b493ac 100644 --- a/docs/main/contributing.rst +++ b/docs/main/contributing.rst @@ -1,9 +1,11 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Contribution ################################################### +.. include:: /main/deprecation_banner.rst + + We welcome all contributions to `axonius-api-client`. Support diff --git a/docs/main/install.rst b/docs/main/install.rst index 8df8017..52eeddb 100644 --- a/docs/main/install.rst +++ b/docs/main/install.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst .. _installation: Installation ######################### +.. include:: /main/deprecation_banner.rst + Install Python ============================================================ diff --git a/docs/main/usage_api/api/adapters/adapters.rst b/docs/main/usage_api/api/adapters/adapters.rst index adeb2d3..05daa84 100644 --- a/docs/main/usage_api/api/adapters/adapters.rst +++ b/docs/main/usage_api/api/adapters/adapters.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Adapters ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.adapters.adapters :members: :show-inheritance: diff --git a/docs/main/usage_api/api/adapters/cnx.rst b/docs/main/usage_api/api/adapters/cnx.rst index 8212d0b..87dcf3b 100644 --- a/docs/main/usage_api/api/adapters/cnx.rst +++ b/docs/main/usage_api/api/adapters/cnx.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Connections ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.adapters.cnx :members: :show-inheritance: diff --git a/docs/main/usage_api/api/adapters/index.rst b/docs/main/usage_api/api/adapters/index.rst index 97e32c0..8949d37 100644 --- a/docs/main/usage_api/api/adapters/index.rst +++ b/docs/main/usage_api/api/adapters/index.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Adapters and connections ############################################### +.. include:: /main/deprecation_banner.rst + .. toctree:: adapters cnx diff --git a/docs/main/usage_api/api/assets/callbacks/base.rst b/docs/main/usage_api/api/assets/callbacks/base.rst index 9116031..243f127 100644 --- a/docs/main/usage_api/api/assets/callbacks/base.rst +++ b/docs/main/usage_api/api/assets/callbacks/base.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Base ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.asset_callbacks.base :members: :show-inheritance: diff --git a/docs/main/usage_api/api/assets/callbacks/csv.rst b/docs/main/usage_api/api/assets/callbacks/csv.rst index 4012fb0..60f2911 100644 --- a/docs/main/usage_api/api/assets/callbacks/csv.rst +++ b/docs/main/usage_api/api/assets/callbacks/csv.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst CSV ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.asset_callbacks.base_csv :members: :show-inheritance: diff --git a/docs/main/usage_api/api/assets/callbacks/index.rst b/docs/main/usage_api/api/assets/callbacks/index.rst index 1bbf6c6..5b6d7cf 100644 --- a/docs/main/usage_api/api/assets/callbacks/index.rst +++ b/docs/main/usage_api/api/assets/callbacks/index.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Export callbacks ############################################### +.. include:: /main/deprecation_banner.rst + .. toctree:: base csv diff --git a/docs/main/usage_api/api/assets/callbacks/json.rst b/docs/main/usage_api/api/assets/callbacks/json.rst index 82c49cf..8093d63 100644 --- a/docs/main/usage_api/api/assets/callbacks/json.rst +++ b/docs/main/usage_api/api/assets/callbacks/json.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst JSON ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.asset_callbacks.base_json :members: :show-inheritance: diff --git a/docs/main/usage_api/api/assets/callbacks/json_to_csv.rst b/docs/main/usage_api/api/assets/callbacks/json_to_csv.rst index 13b507e..3ca012d 100644 --- a/docs/main/usage_api/api/assets/callbacks/json_to_csv.rst +++ b/docs/main/usage_api/api/assets/callbacks/json_to_csv.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst JSON to CSV ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.asset_callbacks.base_json_to_csv :members: :show-inheritance: diff --git a/docs/main/usage_api/api/assets/callbacks/table.rst b/docs/main/usage_api/api/assets/callbacks/table.rst index 95310c0..7fab649 100644 --- a/docs/main/usage_api/api/assets/callbacks/table.rst +++ b/docs/main/usage_api/api/assets/callbacks/table.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Table ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.asset_callbacks.base_table :members: :show-inheritance: diff --git a/docs/main/usage_api/api/assets/callbacks/xlsx.rst b/docs/main/usage_api/api/assets/callbacks/xlsx.rst index 7a5d0a8..2cd607b 100644 --- a/docs/main/usage_api/api/assets/callbacks/xlsx.rst +++ b/docs/main/usage_api/api/assets/callbacks/xlsx.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Excel ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.asset_callbacks.base_xlsx :members: :show-inheritance: diff --git a/docs/main/usage_api/api/assets/devices.rst b/docs/main/usage_api/api/assets/devices.rst index 38afa87..c63c4b4 100644 --- a/docs/main/usage_api/api/assets/devices.rst +++ b/docs/main/usage_api/api/assets/devices.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Device assets ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.assets.devices :members: :show-inheritance: diff --git a/docs/main/usage_api/api/assets/fields.rst b/docs/main/usage_api/api/assets/fields.rst index 9c6bcc9..0c76c9a 100644 --- a/docs/main/usage_api/api/assets/fields.rst +++ b/docs/main/usage_api/api/assets/fields.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Fields ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.assets.fields :members: :show-inheritance: diff --git a/docs/main/usage_api/api/assets/index.rst b/docs/main/usage_api/api/assets/index.rst index 5f60fcf..c857031 100644 --- a/docs/main/usage_api/api/assets/index.rst +++ b/docs/main/usage_api/api/assets/index.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Assets ############################################### +.. include:: /main/deprecation_banner.rst + .. toctree:: devices users diff --git a/docs/main/usage_api/api/assets/labels.rst b/docs/main/usage_api/api/assets/labels.rst index fafe521..63fd69c 100644 --- a/docs/main/usage_api/api/assets/labels.rst +++ b/docs/main/usage_api/api/assets/labels.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Tags ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.assets.labels :members: :show-inheritance: diff --git a/docs/main/usage_api/api/assets/saved_query.rst b/docs/main/usage_api/api/assets/saved_query.rst index c182a2b..7263d07 100644 --- a/docs/main/usage_api/api/assets/saved_query.rst +++ b/docs/main/usage_api/api/assets/saved_query.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Saved queries ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.assets.saved_query :members: :show-inheritance: diff --git a/docs/main/usage_api/api/assets/users.rst b/docs/main/usage_api/api/assets/users.rst index 18b9151..be2ca37 100644 --- a/docs/main/usage_api/api/assets/users.rst +++ b/docs/main/usage_api/api/assets/users.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst User assets ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.assets.users :members: :show-inheritance: diff --git a/docs/main/usage_api/api/assets/wizards/index.rst b/docs/main/usage_api/api/assets/wizards/index.rst index fa6b1d0..0db0705 100644 --- a/docs/main/usage_api/api/assets/wizards/index.rst +++ b/docs/main/usage_api/api/assets/wizards/index.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Query Wizards ############################################### +.. include:: /main/deprecation_banner.rst + .. toctree:: wizard wizard_csv diff --git a/docs/main/usage_api/api/assets/wizards/wizard.rst b/docs/main/usage_api/api/assets/wizards/wizard.rst index c79ebfe..4f9f562 100644 --- a/docs/main/usage_api/api/assets/wizards/wizard.rst +++ b/docs/main/usage_api/api/assets/wizards/wizard.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst From python objects ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.wizards.wizard :members: :show-inheritance: diff --git a/docs/main/usage_api/api/assets/wizards/wizard_csv.rst b/docs/main/usage_api/api/assets/wizards/wizard_csv.rst index 74a85a5..d36272f 100644 --- a/docs/main/usage_api/api/assets/wizards/wizard_csv.rst +++ b/docs/main/usage_api/api/assets/wizards/wizard_csv.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst From CSV files ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.wizards.wizard_csv :members: :show-inheritance: diff --git a/docs/main/usage_api/api/assets/wizards/wizard_text.rst b/docs/main/usage_api/api/assets/wizards/wizard_text.rst index fb3e887..c284b60 100644 --- a/docs/main/usage_api/api/assets/wizards/wizard_text.rst +++ b/docs/main/usage_api/api/assets/wizards/wizard_text.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst From text files ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.wizards.wizard_text :members: :show-inheritance: diff --git a/docs/main/usage_api/api/enforcements/actions.rst b/docs/main/usage_api/api/enforcements/actions.rst index 642bbb4..1b98cca 100644 --- a/docs/main/usage_api/api/enforcements/actions.rst +++ b/docs/main/usage_api/api/enforcements/actions.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Actions ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.enforcements.actions :members: :show-inheritance: diff --git a/docs/main/usage_api/api/enforcements/enforcements.rst b/docs/main/usage_api/api/enforcements/enforcements.rst index 85e4cc1..02de000 100644 --- a/docs/main/usage_api/api/enforcements/enforcements.rst +++ b/docs/main/usage_api/api/enforcements/enforcements.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Enforcements ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.enforcements.enforcements :members: :show-inheritance: diff --git a/docs/main/usage_api/api/enforcements/index.rst b/docs/main/usage_api/api/enforcements/index.rst index 6902a28..3bb117e 100644 --- a/docs/main/usage_api/api/enforcements/index.rst +++ b/docs/main/usage_api/api/enforcements/index.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Enforcements and actions ############################################### +.. include:: /main/deprecation_banner.rst + .. toctree:: enforcements actions diff --git a/docs/main/usage_api/api/system/dashboard.rst b/docs/main/usage_api/api/system/dashboard.rst index 98d712d..80994d2 100644 --- a/docs/main/usage_api/api/system/dashboard.rst +++ b/docs/main/usage_api/api/system/dashboard.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Dashboards and discovery cycles ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.system.dashboard :members: :show-inheritance: diff --git a/docs/main/usage_api/api/system/index.rst b/docs/main/usage_api/api/system/index.rst index b28039a..064dd61 100644 --- a/docs/main/usage_api/api/system/index.rst +++ b/docs/main/usage_api/api/system/index.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst System ########################################################### +.. include:: /main/deprecation_banner.rst + .. toctree:: dashboard instances diff --git a/docs/main/usage_api/api/system/instances.rst b/docs/main/usage_api/api/system/instances.rst index 1abad28..3145018 100644 --- a/docs/main/usage_api/api/system/instances.rst +++ b/docs/main/usage_api/api/system/instances.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Instances ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.system.instances :members: :show-inheritance: diff --git a/docs/main/usage_api/api/system/meta.rst b/docs/main/usage_api/api/system/meta.rst index dd28731..965ad9a 100644 --- a/docs/main/usage_api/api/system/meta.rst +++ b/docs/main/usage_api/api/system/meta.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Product metadata ########################################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.system.meta :members: :show-inheritance: diff --git a/docs/main/usage_api/api/system/settings_global.rst b/docs/main/usage_api/api/system/settings_global.rst index f0fb19b..932aed9 100644 --- a/docs/main/usage_api/api/system/settings_global.rst +++ b/docs/main/usage_api/api/system/settings_global.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst System Settings -> Global Settings ########################################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.system.settings_global :members: :show-inheritance: diff --git a/docs/main/usage_api/api/system/settings_gui.rst b/docs/main/usage_api/api/system/settings_gui.rst index 322e4ca..7ca7a35 100644 --- a/docs/main/usage_api/api/system/settings_gui.rst +++ b/docs/main/usage_api/api/system/settings_gui.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst System Settings -> GUI Settings ########################################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.system.settings_gui :members: :show-inheritance: diff --git a/docs/main/usage_api/api/system/settings_lifecycle.rst b/docs/main/usage_api/api/system/settings_lifecycle.rst index da22026..6261c2d 100644 --- a/docs/main/usage_api/api/system/settings_lifecycle.rst +++ b/docs/main/usage_api/api/system/settings_lifecycle.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst System Settings -> Lifecycle Settings ########################################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.system.settings_lifecycle :members: :show-inheritance: diff --git a/docs/main/usage_api/api/system/signup.rst b/docs/main/usage_api/api/system/signup.rst index df9f63b..0da9eeb 100644 --- a/docs/main/usage_api/api/system/signup.rst +++ b/docs/main/usage_api/api/system/signup.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Initial signup ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.system.signup :members: :show-inheritance: diff --git a/docs/main/usage_api/api/system/system_roles.rst b/docs/main/usage_api/api/system/system_roles.rst index 265ec19..6fc8da9 100644 --- a/docs/main/usage_api/api/system/system_roles.rst +++ b/docs/main/usage_api/api/system/system_roles.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst System Roles ########################################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.system.system_roles :members: :show-inheritance: diff --git a/docs/main/usage_api/api/system/system_users.rst b/docs/main/usage_api/api/system/system_users.rst index 03c82dd..b9a84c8 100644 --- a/docs/main/usage_api/api/system/system_users.rst +++ b/docs/main/usage_api/api/system/system_users.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst System Users ########################################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.api.system.system_users :members: :show-inheritance: diff --git a/docs/main/usage_api/connect.rst b/docs/main/usage_api/connect.rst index d8a0690..528e0dc 100644 --- a/docs/main/usage_api/connect.rst +++ b/docs/main/usage_api/connect.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Connection Handler ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.connect :members: :show-inheritance: diff --git a/docs/main/usage_api/library/api/api_mixins.rst b/docs/main/usage_api/library/api/api_mixins.rst index be519b8..d62e7fa 100644 --- a/docs/main/usage_api/library/api/api_mixins.rst +++ b/docs/main/usage_api/library/api/api_mixins.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst API models ############################################### diff --git a/docs/main/usage_api/library/api/asset_mixins.rst b/docs/main/usage_api/library/api/asset_mixins.rst index 2db3be6..fbfcb9a 100644 --- a/docs/main/usage_api/library/api/asset_mixins.rst +++ b/docs/main/usage_api/library/api/asset_mixins.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Asset API models ############################################### diff --git a/docs/main/usage_api/library/api/index.rst b/docs/main/usage_api/library/api/index.rst index b472f97..395b901 100644 --- a/docs/main/usage_api/library/api/index.rst +++ b/docs/main/usage_api/library/api/index.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst API library backend ############################################### diff --git a/docs/main/usage_api/library/api/routers.rst b/docs/main/usage_api/library/api/routers.rst index 0c4a587..800135b 100644 --- a/docs/main/usage_api/library/api/routers.rst +++ b/docs/main/usage_api/library/api/routers.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Endpoint routers ############################################### diff --git a/docs/main/usage_api/library/api/settings_mixins.rst b/docs/main/usage_api/library/api/settings_mixins.rst index 2ffb190..040314a 100644 --- a/docs/main/usage_api/library/api/settings_mixins.rst +++ b/docs/main/usage_api/library/api/settings_mixins.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Settings mixins ########################################################### diff --git a/docs/main/usage_api/library/auth/api_key.rst b/docs/main/usage_api/library/auth/api_key.rst index 283b9cd..f9d9158 100644 --- a/docs/main/usage_api/library/auth/api_key.rst +++ b/docs/main/usage_api/library/auth/api_key.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Authenticating ############################################### diff --git a/docs/main/usage_api/library/auth/index.rst b/docs/main/usage_api/library/auth/index.rst index 32742f8..752743e 100644 --- a/docs/main/usage_api/library/auth/index.rst +++ b/docs/main/usage_api/library/auth/index.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Authenticating ############################################### diff --git a/docs/main/usage_api/library/auth/models.rst b/docs/main/usage_api/library/auth/models.rst index 43753fd..b7b741a 100644 --- a/docs/main/usage_api/library/auth/models.rst +++ b/docs/main/usage_api/library/auth/models.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Models ############################################### diff --git a/docs/main/usage_api/library/constants/adapters.rst b/docs/main/usage_api/library/constants/adapters.rst index 0f8744e..8e390f7 100644 --- a/docs/main/usage_api/library/constants/adapters.rst +++ b/docs/main/usage_api/library/constants/adapters.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Adapters ############################################### diff --git a/docs/main/usage_api/library/constants/api.rst b/docs/main/usage_api/library/constants/api.rst index 5d5ee2b..9383571 100644 --- a/docs/main/usage_api/library/constants/api.rst +++ b/docs/main/usage_api/library/constants/api.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst API models ############################################### diff --git a/docs/main/usage_api/library/constants/fields.rst b/docs/main/usage_api/library/constants/fields.rst index 710275b..4a19955 100644 --- a/docs/main/usage_api/library/constants/fields.rst +++ b/docs/main/usage_api/library/constants/fields.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Fields ############################################### diff --git a/docs/main/usage_api/library/constants/general.rst b/docs/main/usage_api/library/constants/general.rst index 1538dcf..2cb34fb 100644 --- a/docs/main/usage_api/library/constants/general.rst +++ b/docs/main/usage_api/library/constants/general.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst General ############################################### diff --git a/docs/main/usage_api/library/constants/index.rst b/docs/main/usage_api/library/constants/index.rst index f492a93..20547ab 100644 --- a/docs/main/usage_api/library/constants/index.rst +++ b/docs/main/usage_api/library/constants/index.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Constants ############################################### diff --git a/docs/main/usage_api/library/constants/logs.rst b/docs/main/usage_api/library/constants/logs.rst index eefd6a9..e44fdfc 100644 --- a/docs/main/usage_api/library/constants/logs.rst +++ b/docs/main/usage_api/library/constants/logs.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Logs ############################################### diff --git a/docs/main/usage_api/library/constants/system.rst b/docs/main/usage_api/library/constants/system.rst index a71cfbc..94f624f 100644 --- a/docs/main/usage_api/library/constants/system.rst +++ b/docs/main/usage_api/library/constants/system.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst System ############################################### diff --git a/docs/main/usage_api/library/constants/wizards.rst b/docs/main/usage_api/library/constants/wizards.rst index b36ed09..83dc107 100644 --- a/docs/main/usage_api/library/constants/wizards.rst +++ b/docs/main/usage_api/library/constants/wizards.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Wizards ############################################### diff --git a/docs/main/usage_api/library/index.rst b/docs/main/usage_api/library/index.rst index 6ede0e7..c5a270b 100644 --- a/docs/main/usage_api/library/index.rst +++ b/docs/main/usage_api/library/index.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Library backend ############################################### +.. include:: /main/deprecation_banner.rst + .. toctree:: api/index auth/index diff --git a/docs/main/usage_api/library/parsers/adapters.rst b/docs/main/usage_api/library/parsers/adapters.rst index 8b223bc..87cbcfe 100644 --- a/docs/main/usage_api/library/parsers/adapters.rst +++ b/docs/main/usage_api/library/parsers/adapters.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Adapter schemas ############################################### diff --git a/docs/main/usage_api/library/parsers/config.rst b/docs/main/usage_api/library/parsers/config.rst index cafcea5..5c846e2 100644 --- a/docs/main/usage_api/library/parsers/config.rst +++ b/docs/main/usage_api/library/parsers/config.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Configuration schemas ############################################### diff --git a/docs/main/usage_api/library/parsers/fields.rst b/docs/main/usage_api/library/parsers/fields.rst index d0edb1d..e224807 100644 --- a/docs/main/usage_api/library/parsers/fields.rst +++ b/docs/main/usage_api/library/parsers/fields.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Field schemas ############################################### diff --git a/docs/main/usage_api/library/parsers/index.rst b/docs/main/usage_api/library/parsers/index.rst index ac8522b..345cfd0 100644 --- a/docs/main/usage_api/library/parsers/index.rst +++ b/docs/main/usage_api/library/parsers/index.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Parsers ############################################### diff --git a/docs/main/usage_api/library/parsers/system.rst b/docs/main/usage_api/library/parsers/system.rst index 8f932fe..3fe7fff 100644 --- a/docs/main/usage_api/library/parsers/system.rst +++ b/docs/main/usage_api/library/parsers/system.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst System ############################################### diff --git a/docs/main/usage_api/library/parsers/tables.rst b/docs/main/usage_api/library/parsers/tables.rst index b81dfb5..6f66c15 100644 --- a/docs/main/usage_api/library/parsers/tables.rst +++ b/docs/main/usage_api/library/parsers/tables.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Tables ############################################### diff --git a/docs/main/usage_api/library/parsers/url_parser.rst b/docs/main/usage_api/library/parsers/url_parser.rst index 0ff842e..becfcea 100644 --- a/docs/main/usage_api/library/parsers/url_parser.rst +++ b/docs/main/usage_api/library/parsers/url_parser.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst URLs ############################################### diff --git a/docs/main/usage_api/library/parsers/wizards.rst b/docs/main/usage_api/library/parsers/wizards.rst index eaa2896..f107de0 100644 --- a/docs/main/usage_api/library/parsers/wizards.rst +++ b/docs/main/usage_api/library/parsers/wizards.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Wizards ############################################### diff --git a/docs/main/usage_api/library/tools/data.rst b/docs/main/usage_api/library/tools/data.rst index 436dc69..897b885 100644 --- a/docs/main/usage_api/library/tools/data.rst +++ b/docs/main/usage_api/library/tools/data.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Data classes ############################################### diff --git a/docs/main/usage_api/library/tools/exceptions.rst b/docs/main/usage_api/library/tools/exceptions.rst index 4dd9bf2..2ede4a1 100644 --- a/docs/main/usage_api/library/tools/exceptions.rst +++ b/docs/main/usage_api/library/tools/exceptions.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Exceptions and warnings ############################################### diff --git a/docs/main/usage_api/library/tools/http.rst b/docs/main/usage_api/library/tools/http.rst index b724599..d440918 100644 --- a/docs/main/usage_api/library/tools/http.rst +++ b/docs/main/usage_api/library/tools/http.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst HTTP Client ############################################### diff --git a/docs/main/usage_api/library/tools/index.rst b/docs/main/usage_api/library/tools/index.rst index 100868c..52ab690 100644 --- a/docs/main/usage_api/library/tools/index.rst +++ b/docs/main/usage_api/library/tools/index.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Tools ############################################### diff --git a/docs/main/usage_api/library/tools/logs.rst b/docs/main/usage_api/library/tools/logs.rst index 3eeae7d..985e877 100644 --- a/docs/main/usage_api/library/tools/logs.rst +++ b/docs/main/usage_api/library/tools/logs.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Logging utilities ############################################### diff --git a/docs/main/usage_api/library/tools/setup_env.rst b/docs/main/usage_api/library/tools/setup_env.rst index 999018f..c521217 100644 --- a/docs/main/usage_api/library/tools/setup_env.rst +++ b/docs/main/usage_api/library/tools/setup_env.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Setup environment variables ############################################### diff --git a/docs/main/usage_api/library/tools/tools.rst b/docs/main/usage_api/library/tools/tools.rst index 44d8b03..fad6650 100644 --- a/docs/main/usage_api/library/tools/tools.rst +++ b/docs/main/usage_api/library/tools/tools.rst @@ -1,4 +1,3 @@ -.. include:: /main/deprecation_banner.rst Utilities ############################################### diff --git a/docs/main/usage_api/library/version.rst b/docs/main/usage_api/library/version.rst index eab999b..307b265 100644 --- a/docs/main/usage_api/library/version.rst +++ b/docs/main/usage_api/library/version.rst @@ -1,8 +1,9 @@ -.. include:: /main/deprecation_banner.rst Version metadata ############################################### +.. include:: /main/deprecation_banner.rst + .. automodule:: axonius_api_client.version :members: :show-inheritance: diff --git a/docs/main/usage_api/quickstart.rst b/docs/main/usage_api/quickstart.rst index 871d08d..3924b5a 100644 --- a/docs/main/usage_api/quickstart.rst +++ b/docs/main/usage_api/quickstart.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst .. _api_quickstart: API Quickstart ############################################### +.. include:: /main/deprecation_banner.rst + * Follow the :ref:`Installation` steps * Setup the connection arguments using axonshell :ref:`tools_write_config` * Create a baseline script using :obj:`axonius_api_client.connect.Connect` diff --git a/docs/main/usage_api/usage_api.rst b/docs/main/usage_api/usage_api.rst index bcc63d3..75f12e2 100644 --- a/docs/main/usage_api/usage_api.rst +++ b/docs/main/usage_api/usage_api.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Using the API library ############################################### +.. include:: /main/deprecation_banner.rst + .. toctree:: :maxdepth: 1 diff --git a/docs/main/usage_cli/common_examples/get_by.rst b/docs/main/usage_cli/common_examples/get_by.rst index a04dc0d..18b1fac 100644 --- a/docs/main/usage_cli/common_examples/get_by.rst +++ b/docs/main/usage_cli/common_examples/get_by.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst .. _get_by_ex: Get By Examples ############################################### +.. include:: /main/deprecation_banner.rst + These examples show the various ways that get-by commands can be used. The examples only show individual options being used for the most part, but you can combine any number of these options to have the commands create powerful queries for you. diff --git a/docs/main/usage_cli/common_examples/get_by_examples/ex1.rst b/docs/main/usage_cli/common_examples/get_by_examples/ex1.rst index abad673..1938893 100644 --- a/docs/main/usage_cli/common_examples/get_by_examples/ex1.rst +++ b/docs/main/usage_cli/common_examples/get_by_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Find Single Item - No Match Found ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get a device by hostname that does not exist. diff --git a/docs/main/usage_cli/common_examples/get_by_examples/ex2.rst b/docs/main/usage_cli/common_examples/get_by_examples/ex2.rst index 2b04bce..177f90d 100644 --- a/docs/main/usage_cli/common_examples/get_by_examples/ex2.rst +++ b/docs/main/usage_cli/common_examples/get_by_examples/ex2.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Find Single Item - Match Found ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get a device by hostname that does exist. diff --git a/docs/main/usage_cli/common_examples/get_by_examples/ex3.rst b/docs/main/usage_cli/common_examples/get_by_examples/ex3.rst index f854bf3..3ac8cfa 100644 --- a/docs/main/usage_cli/common_examples/get_by_examples/ex3.rst +++ b/docs/main/usage_cli/common_examples/get_by_examples/ex3.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Find Using Regular Expressions - No Matches Found ################################################# +.. include:: /main/deprecation_banner.rst + This does the following: * Get devices by hostname that match a regular expression. diff --git a/docs/main/usage_cli/common_examples/get_by_examples/ex4.rst b/docs/main/usage_cli/common_examples/get_by_examples/ex4.rst index dc6d5f0..dde373d 100644 --- a/docs/main/usage_cli/common_examples/get_by_examples/ex4.rst +++ b/docs/main/usage_cli/common_examples/get_by_examples/ex4.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Find Using Regular Expressions - Matches Found ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get devices by hostname that match a regular expression. diff --git a/docs/main/usage_cli/common_examples/get_by_examples/ex5.rst b/docs/main/usage_cli/common_examples/get_by_examples/ex5.rst index 2c5620c..fd5bb7c 100644 --- a/docs/main/usage_cli/common_examples/get_by_examples/ex5.rst +++ b/docs/main/usage_cli/common_examples/get_by_examples/ex5.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Find Using NOT ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get devices by hostname that do NOT match a value. diff --git a/docs/main/usage_cli/common_examples/get_by_examples/ex7.rst b/docs/main/usage_cli/common_examples/get_by_examples/ex7.rst index a8eea4f..fd7cbfd 100644 --- a/docs/main/usage_cli/common_examples/get_by_examples/ex7.rst +++ b/docs/main/usage_cli/common_examples/get_by_examples/ex7.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Find Using Multiple Values ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get devices by hostname that match multiple values. diff --git a/docs/main/usage_cli/common_examples/get_by_examples/ex8.rst b/docs/main/usage_cli/common_examples/get_by_examples/ex8.rst index 98ef887..6b17338 100644 --- a/docs/main/usage_cli/common_examples/get_by_examples/ex8.rst +++ b/docs/main/usage_cli/common_examples/get_by_examples/ex8.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Find Matches With A Query Prefix ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get devices by hostname and add ``INCLUDE OUTDATED:`` to the beginning of the diff --git a/docs/main/usage_cli/common_examples/get_by_examples/ex9.rst b/docs/main/usage_cli/common_examples/get_by_examples/ex9.rst index 0c6eda1..27d5277 100644 --- a/docs/main/usage_cli/common_examples/get_by_examples/ex9.rst +++ b/docs/main/usage_cli/common_examples/get_by_examples/ex9.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Find Matches With A Query Postfix ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get devices by hostname and add a filter for installed_software exists to the end diff --git a/docs/main/usage_cli/common_examples/get_by_examples/notes.rst b/docs/main/usage_cli/common_examples/get_by_examples/notes.rst index 4e5bc5b..d86b1db 100644 --- a/docs/main/usage_cli/common_examples/get_by_examples/notes.rst +++ b/docs/main/usage_cli/common_examples/get_by_examples/notes.rst @@ -1,5 +1,4 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Notes ========================================== diff --git a/docs/main/usage_cli/common_examples/select_field_examples/ex1.rst b/docs/main/usage_cli/common_examples/select_field_examples/ex1.rst index 7198717..3c3785c 100644 --- a/docs/main/usage_cli/common_examples/select_field_examples/ex1.rst +++ b/docs/main/usage_cli/common_examples/select_field_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Select Fields: Valid Generic Field ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get device assets and include the ``os.type`` generic field in the response data. diff --git a/docs/main/usage_cli/common_examples/select_field_examples/ex2.rst b/docs/main/usage_cli/common_examples/select_field_examples/ex2.rst index c69417b..c09a38a 100644 --- a/docs/main/usage_cli/common_examples/select_field_examples/ex2.rst +++ b/docs/main/usage_cli/common_examples/select_field_examples/ex2.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Select Fields: Invalid Generic Field ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Raises an error that shows all of the valid generic fields because no generic diff --git a/docs/main/usage_cli/common_examples/select_field_examples/ex3.rst b/docs/main/usage_cli/common_examples/select_field_examples/ex3.rst index 7dba828..5dbf7b8 100644 --- a/docs/main/usage_cli/common_examples/select_field_examples/ex3.rst +++ b/docs/main/usage_cli/common_examples/select_field_examples/ex3.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Select Fields: Invalid Adapter ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Raises an error that shows all of the valid adapters because no adapter diff --git a/docs/main/usage_cli/common_examples/select_field_examples/ex4.rst b/docs/main/usage_cli/common_examples/select_field_examples/ex4.rst index 864ca47..c9a62f5 100644 --- a/docs/main/usage_cli/common_examples/select_field_examples/ex4.rst +++ b/docs/main/usage_cli/common_examples/select_field_examples/ex4.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Select Fields: Multiple Fields ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get device assets and include the generic fields ``os.type`` and ``os.distribution``, diff --git a/docs/main/usage_cli/common_examples/select_field_examples/ex5.rst b/docs/main/usage_cli/common_examples/select_field_examples/ex5.rst index 2e8afbd..3169ab9 100644 --- a/docs/main/usage_cli/common_examples/select_field_examples/ex5.rst +++ b/docs/main/usage_cli/common_examples/select_field_examples/ex5.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Select Fields: Multiple Fields Using Commas ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get device assets and include the generic fields ``os.type`` and ``os.distribution``, diff --git a/docs/main/usage_cli/common_examples/select_field_examples/ex6.rst b/docs/main/usage_cli/common_examples/select_field_examples/ex6.rst index 7afce0b..c220704 100644 --- a/docs/main/usage_cli/common_examples/select_field_examples/ex6.rst +++ b/docs/main/usage_cli/common_examples/select_field_examples/ex6.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Select Fields: No default fields ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get device assets and include the generic field ``os.type``, but don't include the diff --git a/docs/main/usage_cli/common_examples/select_field_examples/ex7.rst b/docs/main/usage_cli/common_examples/select_field_examples/ex7.rst index a67d5bf..910b205 100644 --- a/docs/main/usage_cli/common_examples/select_field_examples/ex7.rst +++ b/docs/main/usage_cli/common_examples/select_field_examples/ex7.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Select Fields: Using Regular Expressions Case 1 ############################################### +.. include:: /main/deprecation_banner.rst + .. note:: :blue:`added in 2.1.4` diff --git a/docs/main/usage_cli/common_examples/select_field_examples/ex8.rst b/docs/main/usage_cli/common_examples/select_field_examples/ex8.rst index cf6513c..b9f584d 100644 --- a/docs/main/usage_cli/common_examples/select_field_examples/ex8.rst +++ b/docs/main/usage_cli/common_examples/select_field_examples/ex8.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Select Fields: Using Regular Expressions Case 2 ############################################### +.. include:: /main/deprecation_banner.rst + .. note:: :blue:`added in 2.1.4` diff --git a/docs/main/usage_cli/common_examples/select_field_examples/notes.rst b/docs/main/usage_cli/common_examples/select_field_examples/notes.rst index 13118ea..f1f0d1e 100644 --- a/docs/main/usage_cli/common_examples/select_field_examples/notes.rst +++ b/docs/main/usage_cli/common_examples/select_field_examples/notes.rst @@ -1,5 +1,4 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Notes ========================================== diff --git a/docs/main/usage_cli/common_examples/select_fields.rst b/docs/main/usage_cli/common_examples/select_fields.rst index 8584d5c..7986e95 100644 --- a/docs/main/usage_cli/common_examples/select_fields.rst +++ b/docs/main/usage_cli/common_examples/select_fields.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst .. _select_fields_ex: Selecting Fields Examples ############################################### +.. include:: /main/deprecation_banner.rst + These examples show how to select what fields (columns in the GUI) are included in responses for getting assets. diff --git a/docs/main/usage_cli/common_examples/settings.rst b/docs/main/usage_cli/common_examples/settings.rst index 1765629..3321831 100644 --- a/docs/main/usage_cli/common_examples/settings.rst +++ b/docs/main/usage_cli/common_examples/settings.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst .. _settings_ex: Settings Examples ############################################### +.. include:: /main/deprecation_banner.rst + These examples show the various ways that settings commands can be used. The examples only show individual options being used for the most part, but you can combine any number of these options to have the commands create powerful queries for you. diff --git a/docs/main/usage_cli/common_examples/settings_examples/ex1.rst b/docs/main/usage_cli/common_examples/settings_examples/ex1.rst index 92f1cef..bba3ea3 100644 --- a/docs/main/usage_cli/common_examples/settings_examples/ex1.rst +++ b/docs/main/usage_cli/common_examples/settings_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Viewing Sections and Sub-Sections ############################################### +.. include:: /main/deprecation_banner.rst + There are a lot of settings that can be configured for the Axonius platform. These are seperated into three groups: ``settings-global``, ``settings-gui`` and `settings-lifecycle``. Inside of each group, settings are split further into sections and sub-sections. So before we can work diff --git a/docs/main/usage_cli/common_examples/settings_examples/ex2.rst b/docs/main/usage_cli/common_examples/settings_examples/ex2.rst index 3c6cc13..a6e518c 100644 --- a/docs/main/usage_cli/common_examples/settings_examples/ex2.rst +++ b/docs/main/usage_cli/common_examples/settings_examples/ex2.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Viewing Section and Sub-Section Values ############################################### +.. include:: /main/deprecation_banner.rst + Now that we know how to see all the sections and sub-sections we can work with. Lets take a look at one and see how it is currently configured. For this example, lets take a look at ``email_settings``. This section contains sub-sections for ``smtpAuth`` and oauthAuth``. diff --git a/docs/main/usage_cli/common_examples/settings_examples/ex3.rst b/docs/main/usage_cli/common_examples/settings_examples/ex3.rst index 21d5184..dcd4e05 100644 --- a/docs/main/usage_cli/common_examples/settings_examples/ex3.rst +++ b/docs/main/usage_cli/common_examples/settings_examples/ex3.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Modifying Values ############################################### +.. include:: /main/deprecation_banner.rst + Viewing settings is all well and good but modifying settings is even better. You are able to modify full sections at once or individual sub-sections. In both cases they can be updated via either command line parameters or using a json file. The related commands are ``update-section``, diff --git a/docs/main/usage_cli/common_examples/settings_examples/notes.rst b/docs/main/usage_cli/common_examples/settings_examples/notes.rst index fc97f2a..d027349 100644 --- a/docs/main/usage_cli/common_examples/settings_examples/notes.rst +++ b/docs/main/usage_cli/common_examples/settings_examples/notes.rst @@ -1,5 +1,4 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Notes ========================================== diff --git a/docs/main/usage_cli/common_options/connection.rst b/docs/main/usage_cli/common_options/connection.rst index 1110a07..2581cb4 100644 --- a/docs/main/usage_cli/common_options/connection.rst +++ b/docs/main/usage_cli/common_options/connection.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst .. _connection_options: Connection Options ############################################### +.. include:: /main/deprecation_banner.rst + All commands have a standard set of required options for connecting to an instance of Axonius: diff --git a/docs/main/usage_cli/common_options/export.rst b/docs/main/usage_cli/common_options/export.rst index 3c3dea1..ac2b019 100644 --- a/docs/main/usage_cli/common_options/export.rst +++ b/docs/main/usage_cli/common_options/export.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst .. _export_options: Export Options ############################################### +.. include:: /main/deprecation_banner.rst + Commands return their data to STDOUT in JSON format by default. You can redirect STDOUT to a file in order to save the data. diff --git a/docs/main/usage_cli/common_options/rows.rst b/docs/main/usage_cli/common_options/rows.rst index 15455dd..90571f8 100644 --- a/docs/main/usage_cli/common_options/rows.rst +++ b/docs/main/usage_cli/common_options/rows.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst .. _rows_option: Rows Option ############################################### +.. include:: /main/deprecation_banner.rst + Any command that has a "-r / --rows" option expects it's input to be from another commands output. diff --git a/docs/main/usage_cli/features/aliases.rst b/docs/main/usage_cli/features/aliases.rst index 32043b4..bc7c96b 100644 --- a/docs/main/usage_cli/features/aliases.rst +++ b/docs/main/usage_cli/features/aliases.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Command Group Aliases ############################################### +.. include:: /main/deprecation_banner.rst + All command groups can be referenced using the most unique short name. Single Matches diff --git a/docs/main/usage_cli/features/autocomplete.rst b/docs/main/usage_cli/features/autocomplete.rst index 5b9cfc9..0300348 100644 --- a/docs/main/usage_cli/features/autocomplete.rst +++ b/docs/main/usage_cli/features/autocomplete.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Autocompletion ############################################### +.. include:: /main/deprecation_banner.rst + Since axonshell is built using `click`_, there is automatic support for bash and zsh `autocompletion`_. Bash diff --git a/docs/main/usage_cli/features/quoting.rst b/docs/main/usage_cli/features/quoting.rst index 2737f49..e28bff5 100644 --- a/docs/main/usage_cli/features/quoting.rst +++ b/docs/main/usage_cli/features/quoting.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst .. _shellhell: Shell Quoting Rules ############################################### +.. include:: /main/deprecation_banner.rst + TBD: Add to axonshell --help-detailed Different shells (powershell, cmd, bash, zsh) have their own nested quoting rules. diff --git a/docs/main/usage_cli/grp_adapters.rst b/docs/main/usage_cli/grp_adapters.rst index e4ae3d3..df8012b 100644 --- a/docs/main/usage_cli/grp_adapters.rst +++ b/docs/main/usage_cli/grp_adapters.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst adapters ############################################### +.. include:: /main/deprecation_banner.rst + This is a command group under the main :doc:`root` that has commands for getting metadata for adapters. diff --git a/docs/main/usage_cli/grp_adapters_cmds/cmd_get.rst b/docs/main/usage_cli/grp_adapters_cmds/cmd_get.rst index 8c3b0ee..fff1505 100644 --- a/docs/main/usage_cli/grp_adapters_cmds/cmd_get.rst +++ b/docs/main/usage_cli/grp_adapters_cmds/cmd_get.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst adapters get ############################################### +.. include:: /main/deprecation_banner.rst + This command allows you to get metadata of adapters and their connections. Common Options diff --git a/docs/main/usage_cli/grp_adapters_cmds/cmd_get_examples/ex1.rst b/docs/main/usage_cli/grp_adapters_cmds/cmd_get_examples/ex1.rst index 489195f..d9eeb24 100644 --- a/docs/main/usage_cli/grp_adapters_cmds/cmd_get_examples/ex1.rst +++ b/docs/main/usage_cli/grp_adapters_cmds/cmd_get_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst No filters, json and json-full exports ############################################### +.. include:: /main/deprecation_banner.rst + .. code:: shell $ # export as STR (the default) to STDOUT diff --git a/docs/main/usage_cli/grp_adapters_cmds/cmd_get_examples/ex_structure.rst b/docs/main/usage_cli/grp_adapters_cmds/cmd_get_examples/ex_structure.rst index 8fd4324..635d216 100644 --- a/docs/main/usage_cli/grp_adapters_cmds/cmd_get_examples/ex_structure.rst +++ b/docs/main/usage_cli/grp_adapters_cmds/cmd_get_examples/ex_structure.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst .. _adapter_structure: Adapter Metadata JSON-FULL Data Structure ############################################### +.. include:: /main/deprecation_banner.rst + The JSON-FULL format returns a list of dictionaries. Each dictionary represents an instance of an adapter on a node and has the keys: diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_count.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_count.rst index c1a8fcb..175276f 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_count.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_count.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices/users count ############################################### +.. include:: /main/deprecation_banner.rst + This command will get the count of assets that a query would return for users or devices and could be used as part of a script to do something based on the number returned. diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query.rst index 6fa29fa..623f6f8 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices/users count-by-saved-query ############################################### +.. include:: /main/deprecation_banner.rst + This command will get the count of assets that a saved query would return for users or devices and could be used as part of a script to do something based on the number returned. diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query_examples/ex1.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query_examples/ex1.rst index 8ecad37..22fd288 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query_examples/ex1.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Invalid Name ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Since the saved query name is invalid, an error will be thrown listing all of the diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query_examples/ex2.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query_examples/ex2.rst index e43d35c..476a66e 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query_examples/ex2.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query_examples/ex2.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Valid Name ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Return the count of assets for the saved query ``SSH Open To Entire Internet``. diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query_examples/notes.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query_examples/notes.rst index 26225b1..4063b98 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query_examples/notes.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_count_by_saved_query_examples/notes.rst @@ -1,5 +1,4 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Notes ========================================== diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/ex1.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/ex1.rst index a8e042d..10558d0 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/ex1.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst With No Query ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Since no query supplied, this will return the count of ALL device assets. diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/ex2.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/ex2.rst index c2b3cbe..2a7108c 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/ex2.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/ex2.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst With Query ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Since a query is supplied, this will only return the count of device assets that match the query. diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/ex3.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/ex3.rst index bdf78b4..fcc715d 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/ex3.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/ex3.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst With Query Using File ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Since a query is supplied, this will only return the count of device assets that match the query. diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/notes.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/notes.rst index 1470ab5..3d1aa49 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/notes.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_count_examples/notes.rst @@ -1,5 +1,4 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Notes ========================================== diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get.rst index 9e70fc9..9dab155 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices/users get ############################################### +.. include:: /main/deprecation_banner.rst + This allows you to get all of the assets for devices or users and export the data to CSV or JSON. diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_id.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_id.rst index 5f72cb7..0ed306a 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_id.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_id.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices/users get-by-id ############################################### +.. include:: /main/deprecation_banner.rst + This command will get ALL data for a single asset. Common Options diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_id_examples/ex1.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_id_examples/ex1.rst index 79b196c..1d48b5d 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_id_examples/ex1.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_id_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Show Default Fields ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Return a list of default fields returned for device queries. diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_id_examples/notes.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_id_examples/notes.rst index 538f3cf..d7370e3 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_id_examples/notes.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_id_examples/notes.rst @@ -1,5 +1,4 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Notes ========================================== diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query.rst index 426a7aa..46077a3 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices/users get-by-saved-query ############################################### +.. include:: /main/deprecation_banner.rst + This command will get assets returned from a saved query for users or devices. Common Options diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/ex1.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/ex1.rst index 2777d85..81c7a9b 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/ex1.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Invalid Name ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Since the saved query name is invalid, an error will be thrown listing all of the diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/ex2.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/ex2.rst index 523dde5..956b724 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/ex2.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/ex2.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Valid Name ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Return the assets of the query and the fields defined in the saved query diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/ex3.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/ex3.rst index 6e0894d..54bd84a 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/ex3.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/ex3.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst .. _tagging_example: Tag/Untag Assets Found In Query ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Tag or untag assets fround in query results using --tag and --untag diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/notes.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/notes.rst index db7de28..18e91b4 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/notes.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_by_saved_query_examples/notes.rst @@ -1,5 +1,4 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Notes ========================================== diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex1.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex1.rst index 4619ed9..3a3125e 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex1.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst With No Query ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Since no query supplied, this will return ALL device assets. diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex2.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex2.rst index 4b9899d..b4812e6 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex2.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex2.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst With Query ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Since a query is supplied, this will only return device assets that match the query. diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex3.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex3.rst index 5aef46b..9f39cee 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex3.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex3.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst With Query Using File ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Since a query is supplied, this will only return device assets that match the query. diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex4.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex4.rst index 81e0e56..26a9323 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex4.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/ex4.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst With Query File And All Fields ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Since a query is supplied, this will only return device assets that match the query. diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/notes.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/notes.rst index e1afb87..56ea579 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/notes.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_examples/notes.rst @@ -1,5 +1,4 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Notes ========================================== diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields.rst index a7861e2..8a0cba4 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices/users get-fields ############################################### +.. include:: /main/deprecation_banner.rst + This command will produce a report of all fields for users or devices. Common Options diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_default.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_default.rst index 9af0d13..ca08e41 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_default.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_default.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices/users get-fields-default ############################################### +.. include:: /main/deprecation_banner.rst + This command will produce a report of the default fields (columns) for users or devices. Common Options diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_default_examples/ex1.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_default_examples/ex1.rst index 9b377ed..77cc88b 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_default_examples/ex1.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_default_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Get ALL device data by ID ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Return all known data for a device diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_default_examples/notes.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_default_examples/notes.rst index 4396db0..6efc37a 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_default_examples/notes.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_default_examples/notes.rst @@ -1,5 +1,4 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Notes ========================================== diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex1.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex1.rst index fd7a51e..2e11d54 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex1.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst All Adapters And All Fields ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Return a list where the keys are the adapter names and the values are diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex2.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex2.rst index 1847929..4739433 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex2.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex2.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Adapter Regex Filter And All Fields ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Return a list where the keys are the adapter names and the values are diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex3.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex3.rst index c0f4078..9ed73e7 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex3.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex3.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Adapter Regex Filter And Fields Regex Filter ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Return a list where the keys are the adapter names and the values are diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex4.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex4.rst index ffd9214..25b0190 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex4.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/ex4.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst All Adapters And Fields Regex Filter ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Return a dictionary of where the keys are the adapter names and the values are a list diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/notes.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/notes.rst index 47e1793..e98b98b 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/notes.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_fields_examples/notes.rst @@ -1,5 +1,4 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Notes ========================================== diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_tags.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_tags.rst index 6c886bc..0f66211 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_tags.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_tags.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices/users get-tags ############################################### +.. include:: /main/deprecation_banner.rst + This allows you to get all of the current tags in the system for devices or users. .. seealso:: diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_tags_examples/ex1.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_tags_examples/ex1.rst index 6ec6624..90a5cc6 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_tags_examples/ex1.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_tags_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Show Current Known Tags ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * This will return all current known tags in the system for devices or users diff --git a/docs/main/usage_cli/grp_assets_cmds/cmd_get_tags_examples/notes.rst b/docs/main/usage_cli/grp_assets_cmds/cmd_get_tags_examples/notes.rst index 8176866..c80f920 100644 --- a/docs/main/usage_cli/grp_assets_cmds/cmd_get_tags_examples/notes.rst +++ b/docs/main/usage_cli/grp_assets_cmds/cmd_get_tags_examples/notes.rst @@ -1,5 +1,4 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Notes ========================================== diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_add.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_add.rst index 36ce429..5ab8077 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_add.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_add.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices/users saved-query add ############################################### +.. include:: /main/deprecation_banner.rst + This command will add a saved query for users or devices. Common Options diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_add_examples/ex1.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_add_examples/ex1.rst index 785c9ff..a001db1 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_add_examples/ex1.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_add_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Create Saved Query ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Create a saved query that includes the ``os.type`` field. diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_add_examples/notes.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_add_examples/notes.rst index 1f0c0c5..c4707c9 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_add_examples/notes.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_add_examples/notes.rst @@ -1,5 +1,4 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Notes ========================================== diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_by_name.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_by_name.rst index ca0ed04..9cbe1b4 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_by_name.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_by_name.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices/users saved-query delete-by-name ############################################### +.. include:: /main/deprecation_banner.rst + This command will delete a saved query by name for users or devices. Common Options diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_by_tags.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_by_tags.rst index 7ebff7a..bdf16ea 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_by_tags.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_by_tags.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices/users saved-query delete-by-tags ############################################### +.. include:: /main/deprecation_banner.rst + This command will delete a saved query by tags for users or devices. Common Options diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_by_tags_examples/ex1.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_by_tags_examples/ex1.rst index e46df36..218d2b9 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_by_tags_examples/ex1.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_by_tags_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Invalid Names ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Throws an error listing all of the valid saved query names as the supplied names diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_examples/ex1.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_examples/ex1.rst index 7ecc996..fe574b4 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_examples/ex1.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Invalid Names ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Throws an error listing all of the valid saved query names as the supplied names diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_examples/ex2.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_examples/ex2.rst index 3a16218..f09b84f 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_examples/ex2.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_examples/ex2.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Valid Names ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Deletes two saved queries after waiting 5 seconds (instead of the default of 30 seconds). diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_examples/notes.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_examples/notes.rst index a89ba89..665a99a 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_examples/notes.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_delete_examples/notes.rst @@ -1,5 +1,4 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Notes ========================================== diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get.rst index c9a35d9..c470ac2 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices/users saved-query get ############################################### +.. include:: /main/deprecation_banner.rst + This command will get all saved queries for users or devices. Common Options diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name.rst index 227d4d1..e635992 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices/users saved-query get-by-name ############################################### +.. include:: /main/deprecation_banner.rst + This command will get a saved query by name for users or devices. Common Options diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex1.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex1.rst index 1a1d8db..19fa744 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex1.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Invalid Name ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Throws an error listing all of the valid saved query names as the supplied names diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex2.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex2.rst index 8c9d11d..6cf1691 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex2.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex2.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Valid Name ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Gets a single saved query by name. diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex3.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex3.rst index 741555d..24552dc 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex3.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex3.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Multiple using Regular Expressions ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Gets multiple saved queries that match a regular expression. diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex4.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex4.rst index 07fb315..2402449 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex4.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/ex4.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Multiple using NOT ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Gets multiple saved queries that do NOT match a set of regular expression. diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/notes.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/notes.rst index bba79f1..bd42c16 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/notes.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_by_name_examples/notes.rst @@ -1,5 +1,4 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Notes ========================================== diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_examples/ex1.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_examples/ex1.rst index a6d751e..0ec529a 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_examples/ex1.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Get All ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Gets all saved queries for device assets. diff --git a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_examples/notes.rst b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_examples/notes.rst index 82e4803..47ff3e2 100644 --- a/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_examples/notes.rst +++ b/docs/main/usage_cli/grp_assets_saved_query_cmds/cmd_get_examples/notes.rst @@ -1,5 +1,4 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Notes ========================================== diff --git a/docs/main/usage_cli/grp_cnx.rst b/docs/main/usage_cli/grp_cnx.rst index 397bc97..6fcdf80 100644 --- a/docs/main/usage_cli/grp_cnx.rst +++ b/docs/main/usage_cli/grp_cnx.rst @@ -1,9 +1,11 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst + adapters cnx ############################################### +.. include:: /main/deprecation_banner.rst + This is a sub-command group under :doc:`grp_adapters` that has commands for getting, adding, deleting, checking (test reachability), and discovering (triggering a fetch) of connections. diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_add.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_add.rst index d070bed..9aa080e 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_add.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_add.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst adapters cnx add ############################################### +.. include:: /main/deprecation_banner.rst + This command will add a new connection for an adapter on a node. Common Options diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex1.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex1.rst index 35a6f7a..361a8d3 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex1.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Prompt for settings ############################################### +.. include:: /main/deprecation_banner.rst + If you don't supply any configuration items on the command line, this command will prompt for the value of each setting for connections of the supplied adapter. diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex2.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex2.rst index 50d4b8b..7b74b2f 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex2.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex2.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Command line options for settings ############################################### +.. include:: /main/deprecation_banner.rst + This way you won't be prompted for the values of each setting, which will allow you to automate adding a new connection. diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex3.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex3.rst index d47a7ac..c61a839 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex3.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex3.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Show the settings needed for a connection in text format ######################################################## +.. include:: /main/deprecation_banner.rst + This can be used to show the connection settings needed so you can build a command line that contains all the necessary settings using ``--config setting_name=setting_value`` diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex4.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex4.rst index fdd0060..cfea1f3 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex4.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_add_examples/ex4.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Show the settings needed for a connection in json format ######################################################## +.. include:: /main/deprecation_banner.rst + This can be used to show the connection settings needed so you can build a command line that contains all the necessary settings using ``--config setting_name=setting_value`` diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_add_from_json.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_add_from_json.rst index df1c935..1d631b8 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_add_from_json.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_add_from_json.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst adapters cnx add-from-json ############################################### +.. include:: /main/deprecation_banner.rst + This command will add a perform a connectivity test for a connection for an adapter on a node. diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_add_from_json_examples/ex1.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_add_from_json_examples/ex1.rst index 2ab587d..7ca032e 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_add_from_json_examples/ex1.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_add_from_json_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Check only working connections for an adapter ################################################## +.. include:: /main/deprecation_banner.rst + This does the following: * Get the AWS adapter on the master node diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_add_from_json_examples/ex2.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_add_from_json_examples/ex2.rst index ffee875..e577067 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_add_from_json_examples/ex2.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_add_from_json_examples/ex2.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Check all connections for an adapter ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get the AWS adapter on the master node diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_by_id.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_by_id.rst index a2ee29f..e4800c4 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_by_id.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_by_id.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst adapters cnx delete-by-id ############################################### +.. include:: /main/deprecation_banner.rst + This command will delete a connection from an adapter on a node. Input feeds diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_examples/ex1.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_examples/ex1.rst index caabb18..a67371e 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_examples/ex1.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Delete with no options ############################################### +.. include:: /main/deprecation_banner.rst + This will throw an error because we didn't supply --force. .. code:: shell diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_examples/ex2.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_examples/ex2.rst index 40c08be..02dac58 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_examples/ex2.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_examples/ex2.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Delete with --force ############################################### +.. include:: /main/deprecation_banner.rst + This will delete a connection in --wait seconds (30 by default). .. code:: shell diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_examples/ex3.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_examples/ex3.rst index 9af9fea..4c55c2a 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_examples/ex3.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_delete_examples/ex3.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Delete with --force --wait 0 --delete-entities ############################################### +.. include:: /main/deprecation_banner.rst + This will delete a connection and all of its associated entities in 0 seconds. .. code:: shell diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_get.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_get.rst index 6c28096..fa3ddf8 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_get.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_get.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst adapters cnx get ############################################### +.. include:: /main/deprecation_banner.rst + This command is used to extract the metadata for connections from the output of the `adapters get` command and optionally filter the connections based on status or id. diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_by_id.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_by_id.rst index 06e507e..4ed48a0 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_by_id.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_by_id.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst adapters cnx get-by-id ############################################### +.. include:: /main/deprecation_banner.rst + This command is used to extract the metadata for connections from the output of the `adapters get` command and optionally filter the connections based on status or id. diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_by_id_examples/ex1.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_by_id_examples/ex1.rst index fbc1c18..67f8ab0 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_by_id_examples/ex1.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_by_id_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst All adapters: all connections ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get all of the adapters. diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex1.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex1.rst index fbc1c18..67f8ab0 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex1.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst All adapters: all connections ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get all of the adapters. diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex2.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex2.rst index 1816fa1..ed4d46f 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex2.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex2.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst All adapters: single connection by invalid ID ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get all of the adapters. diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex3.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex3.rst index c0aecfa..7bb97f3 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex3.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex3.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst All adapters: all working connections ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get all of the adapters. diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex4.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex4.rst index ed5878a..0411e47 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex4.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex4.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst All adapters: all broken connections ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get all of the adapters. diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex5.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex5.rst index 2391b98..d8da7bc 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex5.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex5.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Single adapter: single connection by valid ID ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get the Active Directory adapter. diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex_structure.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex_structure.rst index c76857a..f7e1f0a 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex_structure.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_get_examples/ex_structure.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst .. _cnx_structure: Connecton Metadata JSON Data Structure ============================================== +.. include:: /main/deprecation_banner.rst + The JSON format returns a list of dictionaries. Each dictionary represents an instance of a connection for an adapter on a node diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_test.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_test.rst index 8b59d5b..4c0d551 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_test.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_test.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst adapters cnx test ############################################### +.. include:: /main/deprecation_banner.rst + This command will trigger a test (aka fetch) for a connection of an adapter on a node. Common Options diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_test_by_id.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_test_by_id.rst index d6e265e..3f6fa0a 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_test_by_id.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_test_by_id.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst adapters cnx test-by-id ############################################### +.. include:: /main/deprecation_banner.rst + This command will trigger a test_by_id (aka fetch) for a connection of an adapter on a node. Common Options diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_test_by_id_examples/ex1.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_test_by_id_examples/ex1.rst index fbc1c18..67f8ab0 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_test_by_id_examples/ex1.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_test_by_id_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst All adapters: all connections ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Get all of the adapters. diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_test_examples/ex1.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_test_examples/ex1.rst index 1ac57f7..39fd4ad 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_test_examples/ex1.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_test_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Discover all connections on an adapter ############################################### +.. include:: /main/deprecation_banner.rst + .. code:: shell $ axonshell adapters get --name aws | \ diff --git a/docs/main/usage_cli/grp_cnx_cmds/cmd_test_examples/ex3.rst b/docs/main/usage_cli/grp_cnx_cmds/cmd_test_examples/ex3.rst index 92bf2d5..1a3fb87 100644 --- a/docs/main/usage_cli/grp_cnx_cmds/cmd_test_examples/ex3.rst +++ b/docs/main/usage_cli/grp_cnx_cmds/cmd_test_examples/ex3.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Discover a single connection on an adapter ############################################### +.. include:: /main/deprecation_banner.rst + .. code:: shell $ axonshell adapters get --name aws | \ diff --git a/docs/main/usage_cli/grp_devices.rst b/docs/main/usage_cli/grp_devices.rst index d2cd620..29cefa6 100644 --- a/docs/main/usage_cli/grp_devices.rst +++ b/docs/main/usage_cli/grp_devices.rst @@ -1,9 +1,11 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst + devices ############################################### +.. include:: /main/deprecation_banner.rst + This is a command group under the main :doc:`root` that has commands for getting device assets using queries built by the Query Wizard in the GUI, saved queries, and queries built for you by various ``get-by..`` commands. diff --git a/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_hostname.rst b/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_hostname.rst index 9ddb58a..3e39be5 100644 --- a/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_hostname.rst +++ b/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_hostname.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices get-by-hostname ############################################### +.. include:: /main/deprecation_banner.rst + This command lets you search for devices by hostname and export the data to CSV or JSON. Common Options diff --git a/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_ip.rst b/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_ip.rst index 3b64ec1..631164d 100644 --- a/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_ip.rst +++ b/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_ip.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices get-by-ip ############################################### +.. include:: /main/deprecation_banner.rst + This command lets you search for devices by IP Address and export the data to CSV or JSON. diff --git a/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_mac.rst b/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_mac.rst index 9dd7759..d5dc1d5 100644 --- a/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_mac.rst +++ b/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_mac.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices get-by-mac ############################################### +.. include:: /main/deprecation_banner.rst + This command lets you search for devices by MAC Address and export the data to CSV or JSON. Common Options diff --git a/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_subnet.rst b/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_subnet.rst index 794a317..230176a 100644 --- a/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_subnet.rst +++ b/docs/main/usage_cli/grp_devices_cmds/cmd_get_by_subnet.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices get-by-subnet ############################################### +.. include:: /main/deprecation_banner.rst + This command lets you search for devices that are in a given subnet and export the data to CSV or JSON. Common Options diff --git a/docs/main/usage_cli/grp_devices_saved_query.rst b/docs/main/usage_cli/grp_devices_saved_query.rst index a156bab..e5102f1 100644 --- a/docs/main/usage_cli/grp_devices_saved_query.rst +++ b/docs/main/usage_cli/grp_devices_saved_query.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst devices saved_query ############################################### +.. include:: /main/deprecation_banner.rst + This is a sub-command group under :doc:`grp_devices` that has commands to add, delete, or get saved queries for device assets. diff --git a/docs/main/usage_cli/grp_tools.rst b/docs/main/usage_cli/grp_tools.rst index 8cf6eaa..6f1773e 100644 --- a/docs/main/usage_cli/grp_tools.rst +++ b/docs/main/usage_cli/grp_tools.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst tools ############################################### +.. include:: /main/deprecation_banner.rst + This is a command group under the main :doc:`root` that has commands for starting a python interactive shell and writing a .env configuration file with the credentials and URL for connecting to Axonius. diff --git a/docs/main/usage_cli/grp_tools_cmds/cmd_shell.rst b/docs/main/usage_cli/grp_tools_cmds/cmd_shell.rst index e01e952..55f75f9 100644 --- a/docs/main/usage_cli/grp_tools_cmds/cmd_shell.rst +++ b/docs/main/usage_cli/grp_tools_cmds/cmd_shell.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst tools shell ############################################### +.. include:: /main/deprecation_banner.rst + This command launches a python interactive shell session. The python session will establish a connection to the Axonius instance as a diff --git a/docs/main/usage_cli/grp_tools_cmds/cmd_shell_examples/ex1.rst b/docs/main/usage_cli/grp_tools_cmds/cmd_shell_examples/ex1.rst index 3459172..9eca557 100644 --- a/docs/main/usage_cli/grp_tools_cmds/cmd_shell_examples/ex1.rst +++ b/docs/main/usage_cli/grp_tools_cmds/cmd_shell_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Use interactive python interpreter ############################################### +.. include:: /main/deprecation_banner.rst + This does the following: * Starts the python interpreter. diff --git a/docs/main/usage_cli/grp_tools_cmds/cmd_write_config.rst b/docs/main/usage_cli/grp_tools_cmds/cmd_write_config.rst index 812c3bf..e3907c2 100644 --- a/docs/main/usage_cli/grp_tools_cmds/cmd_write_config.rst +++ b/docs/main/usage_cli/grp_tools_cmds/cmd_write_config.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst .. _tools_write_config: tools write-config ############################################### +.. include:: /main/deprecation_banner.rst + This command will prompt for the :ref:`connection_options`, test if the supplied values connect properly, then write the variables to a .env file in the current working directory. diff --git a/docs/main/usage_cli/grp_tools_cmds/cmd_write_config_examples/ex1.rst b/docs/main/usage_cli/grp_tools_cmds/cmd_write_config_examples/ex1.rst index eeadbdd..fc983a4 100644 --- a/docs/main/usage_cli/grp_tools_cmds/cmd_write_config_examples/ex1.rst +++ b/docs/main/usage_cli/grp_tools_cmds/cmd_write_config_examples/ex1.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Prompt for connection info, test connection, write .env file ############################################################ +.. include:: /main/deprecation_banner.rst + .. raw:: html diff --git a/docs/main/usage_cli/grp_users.rst b/docs/main/usage_cli/grp_users.rst index d0b3de2..894bc53 100644 --- a/docs/main/usage_cli/grp_users.rst +++ b/docs/main/usage_cli/grp_users.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst users ############################################### +.. include:: /main/deprecation_banner.rst + This is a command group under the main :doc:`root` that has commands for getting user assets using queries built by the Query Wizard in the GUI, saved queries, and queries built for you by various ``get-by..`` commands. diff --git a/docs/main/usage_cli/grp_users_cmds/cmd_get_by_mail.rst b/docs/main/usage_cli/grp_users_cmds/cmd_get_by_mail.rst index 662547a..3cc4198 100644 --- a/docs/main/usage_cli/grp_users_cmds/cmd_get_by_mail.rst +++ b/docs/main/usage_cli/grp_users_cmds/cmd_get_by_mail.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst users get-by-mail ############################################### +.. include:: /main/deprecation_banner.rst + This command lets you search for users by email address and export the data to CSV or JSON. Common Options diff --git a/docs/main/usage_cli/grp_users_cmds/cmd_get_by_username.rst b/docs/main/usage_cli/grp_users_cmds/cmd_get_by_username.rst index 3337d3d..d58942f 100644 --- a/docs/main/usage_cli/grp_users_cmds/cmd_get_by_username.rst +++ b/docs/main/usage_cli/grp_users_cmds/cmd_get_by_username.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst users get-by-username ############################################### +.. include:: /main/deprecation_banner.rst + This command lets you search for users by username and export the data to CSV or JSON. Common Options diff --git a/docs/main/usage_cli/grp_users_saved_query.rst b/docs/main/usage_cli/grp_users_saved_query.rst index 5ae53d8..b25060c 100644 --- a/docs/main/usage_cli/grp_users_saved_query.rst +++ b/docs/main/usage_cli/grp_users_saved_query.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst users saved_query ############################################### +.. include:: /main/deprecation_banner.rst + This is a sub-command group under :doc:`grp_users` that has commands to add, delete, or get saved queries for user assets. diff --git a/docs/main/usage_cli/quickstart.rst b/docs/main/usage_cli/quickstart.rst index 82cdbf3..ff77fd7 100644 --- a/docs/main/usage_cli/quickstart.rst +++ b/docs/main/usage_cli/quickstart.rst @@ -1,11 +1,12 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst .. _cli_quickstart: CLI Quickstart ############################################### +.. include:: /main/deprecation_banner.rst + Install the package ============================================== diff --git a/docs/main/usage_cli/root.rst b/docs/main/usage_cli/root.rst index 3497aad..173083d 100644 --- a/docs/main/usage_cli/root.rst +++ b/docs/main/usage_cli/root.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst root ############################################### +.. include:: /main/deprecation_banner.rst + This is the root group of axonshell (aka running the script with no arguments). .. note:: diff --git a/docs/main/usage_cli/usage_cli.rst b/docs/main/usage_cli/usage_cli.rst index 3f9511f..cedd119 100644 --- a/docs/main/usage_cli/usage_cli.rst +++ b/docs/main/usage_cli/usage_cli.rst @@ -1,9 +1,10 @@ .. include:: /main/.special.rst -.. include:: /main/deprecation_banner.rst Using the Command Line Interface ############################################### +.. include:: /main/deprecation_banner.rst + .. toctree:: :maxdepth: 1