Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
vss-cli request change [OPTIONS] COMMAND [ARGS]...

Options

  • --help: Show help information and exit.

Commands

  • get: Retrieve a specific change request.

  • ls: List VM change requests.

  • retry: Retry a VM change request.

  • set: Update a VM change request.

Listing VM Change Requests

To list VM change requests, use the ls command. This command provides various options to filter, sort, and display the requests.

Code Block
vss-cli request change ls [OPTIONS]

Options

  • -f, --filter-by TEXT: Filter the list by <field_name>=<operator>,<value>. Operators include eq, ne, lt, le, gt, ge, like, in.

    • Example: status=eq,Processed filters requests where the status is "Processed".

      Code Block
      vss-cli request change ls -f status=Processed
  • -s, --sort TEXT: Sort the list by <field_name>=<asc|desc>.

    • Example: created_on=desc sorts the list by the creation date in descending order.

      Code Block
      vss-cli request change ls -s created_on=desc
  • -a, --show-all: Show all results without pagination.

  • -c, --count INTEGER: Specify the number of results to display.

  • -p, --page: Page results in a less-like format for easier viewing.

  • --help: Show help information and exit.

Example Commands

  1. Listing All Change Requests

    Code Block
    vss-cli request change ls
  2. Filtering Change Requests by Status

    Code Block
    vss-cli request change ls -f status=eq,Processed
  3. Sorting Change Requests by Creation Date

    Code Block
    vss-cli request change ls -s created_on=desc
  4. Displaying All Results

    Code Block
    vss-cli request change ls -a
  5. Specifying the Number of Results

    Code Block
    vss-cli request change ls -c 10
  6. Paging Results for Easier Viewing

    Code Block
    vss-cli request change ls -p

Getting VM Change Requests Details

The vss-cli request change get command allows you to get various attributes for a VM change request.

Usage

Code Block
vss-cli request change get RID
  • RID: The request ID of the change request you want to update.

Options

  • --help: Show help information and exit.

Retrying a VM Change Request

To retry a VM request that encountered an error, use the retry command with the specific request ID:

...