diff --git a/docs/srvctl-account-balance/description.md b/docs/srvctl-account-balance/description.md index 2e7b584..3527400 100644 --- a/docs/srvctl-account-balance/description.md +++ b/docs/srvctl-account-balance/description.md @@ -1 +1 @@ -This command provides account balance information. +This command provides current account balance and next invoice total due in the account currency. diff --git a/docs/srvctl-cloud-backups/examples.md b/docs/srvctl-cloud-backups/examples.md index 0af772c..a046b54 100644 --- a/docs/srvctl-cloud-backups/examples.md +++ b/docs/srvctl-cloud-backups/examples.md @@ -2,6 +2,7 @@ A command to list all cloud backups for the account: ``` srvctl cloud-backups list +``` A command to get information for a specific cloud backup: diff --git a/docs/srvctl-cloud-instances-add/description.md b/docs/srvctl-cloud-instances-add/description.md index 31936e3..3b4f86b 100644 --- a/docs/srvctl-cloud-instances-add/description.md +++ b/docs/srvctl-cloud-instances-add/description.md @@ -1 +1 @@ -A command to create a new cloud instance. Parameters should be passed via the `-i` or `--input` flag pointing to a JSON file or stdin (`--input -`). +A command to create a new cloud instance. Parameters should be passed via the `-i` or `--input` flag pointing to a JSON file or stdin (`--input -`) for standard input in terminal. Use the `--skeleton` flag to see an example of how to describe a JSON with parameters. diff --git a/docs/srvctl-cloud-instances-upgrade-approve/description.md b/docs/srvctl-cloud-instances-upgrade-approve/description.md index a8001fb..2f09262 100644 --- a/docs/srvctl-cloud-instances-upgrade-approve/description.md +++ b/docs/srvctl-cloud-instances-upgrade-approve/description.md @@ -1 +1 @@ -This command approves a pending upgrade for the selected cloud instance. +This command approves a pending upgrade for the selected cloud instance. It will be automatically approved after 72 hours from the upgrade request. After approval, upgrade can't be reverted. diff --git a/docs/srvctl-cloud-instances-upgrade/description.md b/docs/srvctl-cloud-instances-upgrade/description.md index 0914137..41b0634 100644 --- a/docs/srvctl-cloud-instances-upgrade/description.md +++ b/docs/srvctl-cloud-instances-upgrade/description.md @@ -1 +1 @@ -This command upgrades the selected cloud instance to a new flavor. +This command upgrades the selected cloud instance to a new flavor. You are able to revert upgrade to the previous configuration or approve the changes within 72 hours. After 72 hours, it will be automatically approved. diff --git a/docs/srvctl-cloud-regions-add-snapshot/description.md b/docs/srvctl-cloud-regions-add-snapshot/description.md index 83c5b61..61f6d73 100644 --- a/docs/srvctl-cloud-regions-add-snapshot/description.md +++ b/docs/srvctl-cloud-regions-add-snapshot/description.md @@ -1 +1 @@ -This command creates a new snapshot for the selected cloud region. The `--name` and `--instance-id` flags are required. +This command creates a snapshot for the selected instance within a cloud region. The `--name` and `--instance-id` flags are required. diff --git a/docs/srvctl-cloud-regions-get-credentials/description.md b/docs/srvctl-cloud-regions-get-credentials/description.md index 388f419..b9d1d98 100644 --- a/docs/srvctl-cloud-regions-get-credentials/description.md +++ b/docs/srvctl-cloud-regions-get-credentials/description.md @@ -1 +1 @@ -This command provides credentials for the selected cloud region. +This command provides credentials for the selected cloud region. More details in [Public API documentation](https://developers.servers.com/api-documentation/v1/#tag/Cloud-Credentials). diff --git a/docs/srvctl-cloud-regions-list-snapshots/examples.md b/docs/srvctl-cloud-regions-list-snapshots/examples.md index 780ab45..b62384b 100644 --- a/docs/srvctl-cloud-regions-list-snapshots/examples.md +++ b/docs/srvctl-cloud-regions-list-snapshots/examples.md @@ -9,9 +9,3 @@ A command to filter snapshots by instance: ``` srvctl cloud-regions list-snapshots 42 --instance-id ex4mp1eID ``` - -A command to filter snapshots by backup status: - -``` -srvctl cloud-regions list-snapshots 42 --is-backup -``` diff --git a/docs/srvctl-cloud-regions-list/description.md b/docs/srvctl-cloud-regions-list/description.md index f5e9f95..cfb90dc 100644 --- a/docs/srvctl-cloud-regions-list/description.md +++ b/docs/srvctl-cloud-regions-list/description.md @@ -1 +1 @@ -This command lists available cloud regions. Use `--help` to see available flags. +This command lists cloud regions. Use `--help` to see available flags. diff --git a/docs/srvctl-cloud-regions/examples.md b/docs/srvctl-cloud-regions/examples.md index 2f46f1f..055a838 100644 --- a/docs/srvctl-cloud-regions/examples.md +++ b/docs/srvctl-cloud-regions/examples.md @@ -3,9 +3,3 @@ A command to list all available cloud regions: ``` srvctl cloud-regions list ``` - -A command to get credentials for a specific cloud region: - -``` -srvctl cloud-regions get-credentials 42 -``` diff --git a/docs/srvctl-cloud-volumes-add/examples.md b/docs/srvctl-cloud-volumes-add/examples.md index 9f76688..b2874e0 100644 --- a/docs/srvctl-cloud-volumes-add/examples.md +++ b/docs/srvctl-cloud-volumes-add/examples.md @@ -1,9 +1,3 @@ -A command to show the skeleton JSON structure required to create a cloud volume: - -``` -srvctl cloud-volumes add --skeleton -``` - An example of a command for a file in the same directory with srvctl: ``` diff --git a/docs/srvctl-drive-models/examples.md b/docs/srvctl-drive-models/examples.md index 56ee790..c912b1b 100644 --- a/docs/srvctl-drive-models/examples.md +++ b/docs/srvctl-drive-models/examples.md @@ -1,5 +1,5 @@ A command to list available drive models: ``` -srvctl drive-models --help +srvctl drive-models list ``` diff --git a/docs/srvctl-k8s-list-nodes/examples.md b/docs/srvctl-k8s-list-nodes/examples.md index b82024e..62d8a35 100644 --- a/docs/srvctl-k8s-list-nodes/examples.md +++ b/docs/srvctl-k8s-list-nodes/examples.md @@ -13,5 +13,5 @@ srvctl k8s list-nodes ex4mp1eClusterID --search-pattern "worker" A command to filter nodes by label: ``` -srvctl k8s list-nodes ex4mp1eClusterID --label-selector "role=worker" +srvctl k8s list-nodes ex4mp1eClusterID --label-selector "team=devops" ``` diff --git a/docs/srvctl-k8s-list/examples.md b/docs/srvctl-k8s-list/examples.md index 02cf826..0e5088f 100644 --- a/docs/srvctl-k8s-list/examples.md +++ b/docs/srvctl-k8s-list/examples.md @@ -7,7 +7,7 @@ srvctl k8s list A command to filter Kubernetes clusters by location: ``` -srvctl k8s list --location-id "LON1" +srvctl k8s list --location-id 1 ``` A command to filter Kubernetes clusters by label: diff --git a/docs/srvctl-l2-segments-add/description.md b/docs/srvctl-l2-segments-add/description.md index 8dc1c00..1164f78 100644 --- a/docs/srvctl-l2-segments-add/description.md +++ b/docs/srvctl-l2-segments-add/description.md @@ -1,5 +1,5 @@ A command to create a new L2 segment. It allows to pass parameters in two ways: -- Input - segment parameters are described in a file, a path to the file is specified via the `-i` or `--input` flag. The path can be absolute or relative to the srvctl file. Parameters should be described as a request body of the Public API request. There is also an option to use standard input (stdin) when specifying the flag this way: `--input -` +- Input - segment parameters are described in a file, a path to the file is specified via the `-i` or `--input` flag. The path can be absolute or relative to the srvctl file. Use the `--skeleton` flag to see an example of how to describe a JSON with parameters. There is also an option to use standard input (stdin) when specifying the flag this way: `--input -` - Flags - parameters are specified via flags inside the command. The `--type` and `--member` flags are required. Members are specified in `id=,mode=` format and can be repeated for multiple members. diff --git a/docs/srvctl-l2-segments-list-groups/examples.md b/docs/srvctl-l2-segments-list-groups/examples.md index 84088b1..603e39e 100644 --- a/docs/srvctl-l2-segments-list-groups/examples.md +++ b/docs/srvctl-l2-segments-list-groups/examples.md @@ -1,7 +1,8 @@ A command to list all L2 segment location groups: ``` -srvctl l2-segments list-groups``` +srvctl l2-segments list-groups +``` A command to filter location groups by type: diff --git a/docs/srvctl-l2-segments-update-networks/examples.md b/docs/srvctl-l2-segments-update-networks/examples.md index fdce2e8..b14ed9d 100644 --- a/docs/srvctl-l2-segments-update-networks/examples.md +++ b/docs/srvctl-l2-segments-update-networks/examples.md @@ -1,7 +1,7 @@ A command to show the skeleton JSON structure required to update L2 segment networks: ``` -srvctl l2-segments update-networks --skeleton +srvctl l2-segments update-networks ex4mp1eID --skeleton ``` A command to update networks for the L2 segment with the "ex4mp1eID" ID using an input file: diff --git a/docs/srvctl-l2-segments-update/description.md b/docs/srvctl-l2-segments-update/description.md index 9a55e56..37c8c3c 100644 --- a/docs/srvctl-l2-segments-update/description.md +++ b/docs/srvctl-l2-segments-update/description.md @@ -1 +1 @@ -This command updates an L2 segment by id. Parameters should be passed via the `-i` or `--input` flag pointing to a JSON file or stdin (`--input -`). +This command updates an L2 segment by id. Parameters should be passed via the `-i` or `--input` flag pointing to a JSON file or stdin (`--input -`). Use the `--skeleton` flag to see the JSON file structure. diff --git a/docs/srvctl-l2-segments-update/examples.md b/docs/srvctl-l2-segments-update/examples.md index 613c17e..3ebd88e 100644 --- a/docs/srvctl-l2-segments-update/examples.md +++ b/docs/srvctl-l2-segments-update/examples.md @@ -1,7 +1,7 @@ A command to show the skeleton JSON structure required to update an L2 segment: ``` -srvctl l2-segments update --skeleton +srvctl l2-segments update ex4mp1eID --skeleton ``` A command to update the L2 segment with the "ex4mp1eID" ID using an input file: diff --git a/docs/srvctl-lb-l4-add/description.md b/docs/srvctl-lb-l4-add/description.md index d221167..faf85c2 100644 --- a/docs/srvctl-lb-l4-add/description.md +++ b/docs/srvctl-lb-l4-add/description.md @@ -1 +1 @@ -A command to create a new L4 load balancer. +A command to create a new L4 load balancer. LB parameters should be described in a file, a path to the file is specified via the `-i` or `--input` flag. The path can be absolute or relative to the srvctl file. There is also an option to use standard input (stdin) when specifying the flag this way: `--input -`. Use the `--skeleton` flag to see JSON structure of the file. diff --git a/docs/srvctl-lb-l4-add/examples.md b/docs/srvctl-lb-l4-add/examples.md index 5d2f33e..30e42f1 100644 --- a/docs/srvctl-lb-l4-add/examples.md +++ b/docs/srvctl-lb-l4-add/examples.md @@ -10,12 +10,6 @@ A command to create a new L4 load balancer using a JSON file: srvctl lb l4 add --input /path/to/input.json ``` -A command to create a new L4 load balancer using stdin: - -``` -cat input.json | srvctl lb l4 add --input - -``` - JSON structure example: ```json diff --git a/docs/srvctl-lb-l4-list/examples.md b/docs/srvctl-lb-l4-list/examples.md index c412857..dd91e70 100644 --- a/docs/srvctl-lb-l4-list/examples.md +++ b/docs/srvctl-lb-l4-list/examples.md @@ -7,7 +7,7 @@ srvctl lb l4 list A command to filter L4 load balancers by location: ``` -srvctl lb l4 list --location-id "LON1" +srvctl lb l4 list --location-id 5 ``` A command to filter L4 load balancers by cluster: diff --git a/docs/srvctl-lb-l4-update/description.md b/docs/srvctl-lb-l4-update/description.md index 49bc579..a889741 100644 --- a/docs/srvctl-lb-l4-update/description.md +++ b/docs/srvctl-lb-l4-update/description.md @@ -1 +1 @@ -This command updates the selected L4 load balancer. +This command updates the selected L4 load balancer using a JSON file specified via the `--input` flag. Use the `--skeleton` flag to see the JSON structure. diff --git a/docs/srvctl-lb-l4-update/examples.md b/docs/srvctl-lb-l4-update/examples.md index e0bd44d..5b3af31 100644 --- a/docs/srvctl-lb-l4-update/examples.md +++ b/docs/srvctl-lb-l4-update/examples.md @@ -1,7 +1,7 @@ A command to get the JSON structure required to update an L4 load balancer: ``` -srvctl lb l4 update --skeleton +srvctl lb l4 update ex4mp1eID --skeleton ``` A command to update the L4 load balancer with the "ex4mp1eID" ID using a JSON file: @@ -10,12 +10,6 @@ A command to update the L4 load balancer with the "ex4mp1eID" ID using a JSON fi srvctl lb l4 update ex4mp1eID --input /path/to/input.json ``` -A command to update the L4 load balancer using stdin: - -``` -cat input.json | srvctl lb l4 update ex4mp1eID --input - -``` - JSON structure example: ```json diff --git a/docs/srvctl-lb-l7-add/description.md b/docs/srvctl-lb-l7-add/description.md index 3889cb1..b6de553 100644 --- a/docs/srvctl-lb-l7-add/description.md +++ b/docs/srvctl-lb-l7-add/description.md @@ -1 +1 @@ -A command to create a new L7 load balancer. +A command to create a new L7 load balancer. LB parameters should be described in a file, a path to the file is specified via the `-i` or `--input` flag. The path can be absolute or relative to the srvctl file. There is also an option to use standard input (stdin) when specifying the flag this way: `--input -`. Use the `--skeleton` flag to see JSON structure of the file. diff --git a/docs/srvctl-lb-l7-add/examples.md b/docs/srvctl-lb-l7-add/examples.md index fa963e5..33319ed 100644 --- a/docs/srvctl-lb-l7-add/examples.md +++ b/docs/srvctl-lb-l7-add/examples.md @@ -10,12 +10,6 @@ A command to create a new L7 load balancer using a JSON file: srvctl lb l7 add --input /path/to/input.json ``` -A command to create a new L7 load balancer using stdin: - -``` -cat input.json | srvctl lb l7 add --input - -``` - JSON structure example: ```json diff --git a/docs/srvctl-lb-l7-list/examples.md b/docs/srvctl-lb-l7-list/examples.md index a79d23d..62bc32a 100644 --- a/docs/srvctl-lb-l7-list/examples.md +++ b/docs/srvctl-lb-l7-list/examples.md @@ -13,7 +13,7 @@ srvctl lb l7 list --all A command to filter L7 load balancers by location: ``` -srvctl lb l7 list --location-id "LON1" +srvctl lb l7 list --location-id 5 ``` A command to filter L7 load balancers by cluster: diff --git a/docs/srvctl-lb-l7-update/description.md b/docs/srvctl-lb-l7-update/description.md index 106fa11..1b2bc84 100644 --- a/docs/srvctl-lb-l7-update/description.md +++ b/docs/srvctl-lb-l7-update/description.md @@ -1 +1 @@ -This command updates the selected L7 load balancer. +This command updates the selected L7 load balancer using a JSON file specified via the `--input` flag. Use the `--skeleton` flag to see the JSON structure. diff --git a/docs/srvctl-lb-l7-update/examples.md b/docs/srvctl-lb-l7-update/examples.md index 0f71dff..69f36af 100644 --- a/docs/srvctl-lb-l7-update/examples.md +++ b/docs/srvctl-lb-l7-update/examples.md @@ -10,12 +10,6 @@ A command to update the L7 load balancer with the "ex4mp1eID" ID using a JSON fi srvctl lb l7 update ex4mp1eID --input /path/to/input.json ``` -A command to update the L7 load balancer using stdin: - -``` -cat input.json | srvctl lb l7 update ex4mp1eID --input - -``` - JSON structure example: ```json diff --git a/docs/srvctl-lb-list/examples.md b/docs/srvctl-lb-list/examples.md index 08ff33d..452afa4 100644 --- a/docs/srvctl-lb-list/examples.md +++ b/docs/srvctl-lb-list/examples.md @@ -13,7 +13,7 @@ srvctl lb list --all A command to filter load balancers by location: ``` -srvctl lb list --location-id "LON1" +srvctl lb list --location-id 5 ``` A command to filter load balancers by cluster: diff --git a/docs/srvctl-lb/description.md b/docs/srvctl-lb/description.md index ccd085c..2d7b77a 100644 --- a/docs/srvctl-lb/description.md +++ b/docs/srvctl-lb/description.md @@ -1 +1 @@ -This command allows to manage load balancers of different types (l4, l7). +This command allows to manage load balancers. Select the specific type (`l4` or `l7`) to see available operations for each one. diff --git a/docs/srvctl-network-pools-list/examples.md b/docs/srvctl-network-pools-list/examples.md index 15d0647..0c54ac2 100644 --- a/docs/srvctl-network-pools-list/examples.md +++ b/docs/srvctl-network-pools-list/examples.md @@ -13,7 +13,7 @@ srvctl network-pools list --all A command to filter network pools by location: ``` -srvctl network-pools list --location-id "LON1" +srvctl network-pools list --location-id 42 ``` A command to filter network pools by type: diff --git a/docs/srvctl-racks-list/examples.md b/docs/srvctl-racks-list/examples.md index 2834367..4b900df 100644 --- a/docs/srvctl-racks-list/examples.md +++ b/docs/srvctl-racks-list/examples.md @@ -7,7 +7,7 @@ srvctl racks list --all A command to filter private racks by location: ``` -srvctl racks list --location-id ex4mp1eID +srvctl racks list --location-id 5 ``` A command to filter private racks by label: diff --git a/docs/srvctl-racks/examples.md b/docs/srvctl-racks/examples.md index 31c0d9b..3131528 100644 --- a/docs/srvctl-racks/examples.md +++ b/docs/srvctl-racks/examples.md @@ -2,8 +2,10 @@ A command to list all private racks for the account: ``` srvctl racks list --all +``` -srvctl racks get +A command to get details of a specific rack: -srvctl racks update +``` +srvctl racks get ``` diff --git a/docs/srvctl-ssl-custom-add/description.md b/docs/srvctl-ssl-custom-add/description.md index 338e0cd..f5883ed 100644 --- a/docs/srvctl-ssl-custom-add/description.md +++ b/docs/srvctl-ssl-custom-add/description.md @@ -1,5 +1,5 @@ A command to create a new custom SSL certificate. It allows to pass parameters in two ways: -- Input - certificate parameters are described in a file, a path to the file is specified via the `-i` or `--input` flag. The path can be absolute or relative to the srvctl file. Parameters should be described as a request body of the Public API request. There is also an option to use standard input (stdin) when specifying the flag this way: `--input -` +- Input - certificate parameters are described in a JSON file, a path to the file is specified via the `-i` or `--input` flag. The path can be absolute or relative to the srvctl file. Use the `--skeleton` flag to see the file's pattern. There is also an option to use standard input (stdin) when specifying the flag this way: `--input -` - Flags - parameters are specified via flags inside the command. The `--name`, `--public-key`, and `--private-key` flags are required. The `--chain-key` flag is optional. diff --git a/docs/srvctl-ssl-list/description.md b/docs/srvctl-ssl-list/description.md index 0218a00..0c9856b 100644 --- a/docs/srvctl-ssl-list/description.md +++ b/docs/srvctl-ssl-list/description.md @@ -1 +1 @@ -This command lists all SSL certificates of the account regardless of type. Use `--help` to see available flags. +This command lists all custom and Let's Encrypt SSL certificates of the account. Use `--help` to see available flags. diff --git a/docs/srvctl-ssl/description.md b/docs/srvctl-ssl/description.md index 7b00c2a..3bc1c0a 100644 --- a/docs/srvctl-ssl/description.md +++ b/docs/srvctl-ssl/description.md @@ -1 +1 @@ -You can manage your SSL certificates by performing commands listed in `srvctl ssl --help`. Two certificate types are supported: custom certificates (`ssl custom`) and Let's Encrypt certificates (`ssl le`). +You can manage your SSL certificates by performing commands listed in `srvctl ssl --help`. Two certificate types are supported: custom (`custom`) and Let's Encrypt (`le`).