From b2ba31984e4fbac05ea56f61c6b78c45090d5514 Mon Sep 17 00:00:00 2001 From: ejherlig Date: Sun, 19 Jan 2025 12:25:02 +0000 Subject: [PATCH] Create config.rst The "config" subcommand exists but is not documented. This file documents the subcommand with a few examples. --- docs/chapters/subcommands/config.rst | 32 ++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/chapters/subcommands/config.rst diff --git a/docs/chapters/subcommands/config.rst b/docs/chapters/subcommands/config.rst new file mode 100644 index 00000000..aa583ca4 --- /dev/null +++ b/docs/chapters/subcommands/config.rst @@ -0,0 +1,32 @@ +======= +config +======= + +Gets or sets properties for a target container. + +.. code-block:: shell + + Usage: bastille config TARGET get|set propertyName [newValue] + +Getting a property that *is* defined in jail.conf: + +.. code-block:: shell + + ishmael ~ # bastille config azkaban get ip4.addr + 192.168.2.23 + +Getting a property that *is not* defined in jail.conf + +.. code-block:: shell + + ishmael ~ # bastille config azkaban get notaproperty + not set + +Setting a property: + +.. code-block:: shell + + ishmael ~ # bastille config azkaban set ip4.addr 192.168.2.24 + A restart is required for the changes to be applied. See 'bastille restart azkaban'. + +The restart message will appear every time a property is set.