man(1) page: cloudscheduler group delete¶
- NAME
- cloudscheduler group delete - delete groups from cloudscheduler version 2 (csv2) servers
- SYNOPSIS
- cloudscheduler group delete -gn name [ options …]
- DESCRIPTION
- The cloudscheduler group delete action deletes groups from csv2 servers. This action is only available to privileged users. All objects(group defaults, group metadata, cloud definitions, cloud metadata, jobs, and VMs) associated with the group will be deleted as well. *PLANNED: If a group has running jobs or VMs the delete will fail.*
- OPTIONS
- Mandatory
The following are mandatory parameters and must be specified:
- -gn name, --group-name name
- The group name. The value for name must be one to thirty-two characters, all lower case, numeric digits, and dashes but cannot start or end with dashes.
- Optional
The following are optional parameters:
- -Y , --yes
- Specify this option to automatically accept the deletion. If not specified a prompt will appear asking if the user is sure they would like to delete the object..
- Global
These options are avaliable on all actions:.so ../man/parameters/_group.so
- -H , --long-help
- Requests the man page style help for the current command. Long help can be requested for the cloudscheduler command, a specific object, or a specific object/action.
- -h , --help
- Requests short help for the current command. Help can be requested for the cloudscheduler command, a specific object, or a specific object/action.
- -s server, --server server
- The name of the target server. There must be an entry in the cloudscheduler defaults that matches server and it must have an authentication method.
- -v , --version
- Requests that the versions of both the CLI client and the targeted server be printed in addition to any other command output.
- -xA , --expose-API
- Requests trace messages detailing the API calls and responses issued and received by the cloudscheduler command.
- EXAMPLES
- Deleting the group “example”: $ cloudscheduler group delete -gn example -Y group “example” successfully deleted.
- SEE ALSO
- csv2 (1) csv2_group (1) csv2_group_add (1) csv2_group_defaults (1) csv2_group_list (1) csv2_group_metadata-delete (1) csv2_group_metadata- edit (1) csv2_group_metadata-list (1) csv2_group_metadata-load (1) csv2_group_metadata-update (1) csv2_group_update (1)
cloudscheduler version 2 7 November 2018 cloudscheduler(1)