summaryrefslogtreecommitdiffstats
path: root/awxkit
diff options
context:
space:
mode:
authorJeff Bradberry <jeff.bradberry@gmail.com>2020-06-18 21:32:49 +0200
committerJeff Bradberry <jeff.bradberry@gmail.com>2020-06-18 21:32:49 +0200
commit393369adec482f73e963b73832e7e3ff8b689542 (patch)
tree0c2581ea10f1ac97a53f01c2d7122f6fb82c13fc /awxkit
parentContinue after failures to grant roles (diff)
downloadawx-393369adec482f73e963b73832e7e3ff8b689542.tar.xz
awx-393369adec482f73e963b73832e7e3ff8b689542.zip
First cut at examples of the import and export commands
Diffstat (limited to 'awxkit')
-rw-r--r--awxkit/awxkit/cli/docs/source/examples.rst36
1 files changed, 32 insertions, 4 deletions
diff --git a/awxkit/awxkit/cli/docs/source/examples.rst b/awxkit/awxkit/cli/docs/source/examples.rst
index 592f60eec9..95d6ecb966 100644
--- a/awxkit/awxkit/cli/docs/source/examples.rst
+++ b/awxkit/awxkit/cli/docs/source/examples.rst
@@ -59,9 +59,37 @@ Importing an SSH Key
--name 'My SSH Key' --user 'alice' \
--inputs '{"username": "server-login", "ssh_key_data": "@~/.ssh/id_rsa"}'
-Backup/Restore
---------------
+Import/Export
+-------------
-The AWX CLI doesn't currently have official support for backing up and restoring resources (similar to `tower-cli send` and `tower-cli receive`).
+Intended to be similar to `tower-cli send` and `tower-cli receive`.
-If you rely on this functionality, you should continue to use `tower-cli` at this time.
+Exporting everything:
+
+.. code:: bash
+
+ awx export
+
+Exporting everything of some particular type or types:
+
+.. code:: bash
+
+ awx export --users
+
+Exporting a particular named resource:
+
+.. code:: bash
+
+ awx export --users admin
+
+Exporting a resource by id:
+
+.. code:: bash
+
+ awx export --users 42
+
+Importing a set of resources stored as a file:
+
+.. code:: bash
+
+ awx import < resources.json