.. File generated by /hepuser/crlb/Git/cloudscheduler/utilities/cli_doc_to_rst - DO NOT EDIT
..
.. To modify the contents of this file:
..   1. edit the man page file(s) ".../cloudscheduler/cli/man/csv2_metadata_group-defaults.1"
..   2. run the utility ".../cloudscheduler/utilities/cli_doc_to_rst"
..

man(1) page: cloudscheduler metadata group-defaults
===================================================

 
 
 
**NAME**  
       **cloudscheduler metadata group-defaults** 
       - modify and view group defaults 
       on cloudscheduler version 2 (csv2) servers
 
**SYNOPSIS**  
       **cloudscheduler metadata group-defaults** 
       [ *options*
       ...] 
 
**DESCRIPTION**  
       The **cloudscheduler metadata group-defaults** 
       action modifies and displays 
       group  defaults  from  csv2  servers.   This action is available to all
       users, provided they are in the group  that  the  defaults  belong  to.
       Priviliged  users  may  also use the **cloudscheduler group defaults**  
       command.
 
**OPTIONS**  
   **Optional**  
       The following are optional parameters:
 
       **-jc** *cores*,  **\\-\\-job-cores** *cores* 
              The number of VM cores allocated to jobs started in the  current
              group.   The value for *cores*
              must be an integer value.  Default: 
              1
 
       **-jd** *disk*,  **\\-\\-job-disk** *disk* 
              The number of GBs to allocate to jobs  started  in  the  current
              group.  The value for *disk*
              must be an integer value.  Default: 5 
 
       **-jr** *ram*,  **\\-\\-job-ram** *ram* 
              The  numder  of  MBs  of  ram to allocate to jobs in the current
              group.  The value for *ram*
              must be an  integer  value.   Default: 
              1000
 
       **-js** *swap*,  **\\-\\-job-swap** *swap* 
              The  number  of  GBs  of swap to allocate to jobs started in the
              current group.  The value for *swap*
              must  be  an  integer  value. 
              Default: 0
 
       **-vf** *flavor*
       [, ...], **\\-\\-vm-flavor** *flavor*
       [, ...] 
              The  flavors to be used for VMs started on clouds in this group.
              Where *flavor*
              is a list of comma seperated VM flavor  names  that 
              can  be used.  The value in *flavor*
              will only be used if no value 
              is specified for **vm-flavor** 
              on the **cloud** . 
              If *flavor*
              is not 
              specified  in  the  group or cloud the flavor of started VMs will be
              calculated from the job requirements.  Default: None
 
       **-vi** *image*,  **\\-\\-vm-image** *image* 
              The images to be used for VMs started  on  this  groups  clouds.
              Where *image*
              is a list of comma seperated VM image names that can 
              be used.  The value in *image*
              will only be used if  no  value  is 
              specified  for **vm-image** 
              on the **cloud** . 
              If *image*
              is not specified 
              in the group or cloud the image of started VMs  will  be  
              calculated from the job requirements.  Default: None
 
       **-vka** *time*,  **\\-\\-vm-keep-alive** *time* 
              The  number of second the VM will be left idle before being 
              terminated if no jobs are started on it.  The value  in  *time*
              will 
              only  be  used if no value is specified for **vm-keep-alive** 
              on the 
              **cloud** . 
              Default: None 
 
   **Table**  
       These options change the format of the displayed table(s):
 
       **-CSV** *column1*
       [,column2,...  columnN], **\\-\\-comma-separated-values** *col-* 
       *umn1*
       [,column2,... columnN] 
              Requests  that  a  list  of  comma separated values be displayed
              instead of tabular output.  Only the specified columns  will  be
              displayed  from  the  current view (see **\\-\\-view** ). 
              To display all 
              columns from the  current  view,  specify  a  null  string,  ie.
              "--comma-separated-values ''".
 
 
       **-CSEP** *separator*,  **\\-\\-comma-separated-values-separator** *separator* 
              Specifies  the column separator character to be used by the -CSV
              parameter when printing the result.  By default, a  comma  (",")
              is used.
 
 
       **-NV** ,  **\\-\\-no-view**  
              Ignores any defined view (see **\\-\\-view** 
              ) for this invocation of the 
              command.  All columns present in the list will be displayed.
 
       **-ok** ,  **\\-\\-only-keys**  
              Only displays the values of the keys in  this  list.   No  other
              columns are displayed.
 
       **-r** ,  **\\-\\-rotate**  
              Rotate  the  listed table to only have a **Key** 
              and a **Value** 
              column. 
              Used to improve readability of tables with many columns.
 
       **-V** *column1*
       [,column2,... columnN], **\\-\\-view** *column1*
       [,column2,... columnN] 
              Specifies a comma-seperated list of table column names which are
              to be displayed.  All other columns will be ignored.  For a 
              command that produces multiple result tables, the column name  list
              for  each table is separated by a slash (**/** ). 
              Using this 
              parameter defines a "view" for this and all subsequent invocations  of
              this command; the same column selections will be displayed until
              the "view" is redefined by the **\\-\\-view** 
              option.  To remove a view, 
              specify  a  null  string,  ie.  "--with  ''", in which case, all
              defined columns will be displayed.  To see which tables and 
              columns that can be displayed, use the **\\-\\-view-columns** 
              option. 
 
              Default: None.
 
       **-VC** ,  **\\-\\-view-columns**  
              View  all  table  and column names associated with this command.
              For each table of information returned by the command,  a  table
              number, table name, a possible "optional" designation, the "key"
              column (those that are displayed at the beginning of every  
              segment) names, and all remaining column names are displayed.  This
              information is useful when creating views (see **\\-\\-view** 
              )  or  when 
              selecting  columns for comma separated output (see **\\-\\-comma-sepa-**  
              **rated-values** ).  
 
       **-w** *table1*
       [,table2,... tableN], **\\-\\-with** *table1*
       [,table2,... tableN] 
              Specifies a comma-seperated list of names of optional tables  to
              be  displayed.   Some  commands  provide  additional information
              which are not displayed unless specifically requested  by  name.
              To determine the information returned by any particular command,
              use the **\\-\\-view-columns** 
              ( **-VC** 
              ) option which provides a list of 
              table  numbers,  tables names, and columns, high-lighting optional
              information.  This option  accepts  table  numbers  as  well  as
              tables names and the special value of **ALL** 
              which will display all 
              optional information.
 
              Default: None.
 
   **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**  
       1.     Viewing defaults for the group "example":
              $ cloudscheduler metadata group-defaults -g example
              Server: default, Active User: example, Active Group: example, User's Groups: ['example', 'testing']
 
              Active Group Defaults:

              +---------+--------+-------+------------+-------------+-------------+-------------+-------------+
              +         |             VM              |                          Job                          +
              +  Group  | Flavor   Image   Keep Alive |    Cores      Disk (GBs)     RAM (MBs)    Swap (GBs)  +
              +=========+========+=======+============+=============+=============+=============+=============+
              | example | None   | None  | None       | 1           | 5           | 1000        | 0           |
              +---------+--------+-------+------------+-------------+-------------+-------------+-------------+

              Rows: 1
 
       2.     Updating the default for the group "example":
              $ cloudscheduler metadata group-defaults -g example -jc 2 -jd 10 -jr 2000 -js 1 -vf 'flavor-name1,flavor-name2' -vi 'image-name1,image-name2' -vka 60
              group defaults "example" successfully updated.
              Server: default, Active User: example, Active Group: example, User's Groups: ['example', 'testing']
 
              Active Group Defaults:

              +---------+---------------------------+-------------------------+-------------+-------------+-------------+-------------+-------------+
              +         |                                VM                                 |                          Job                          +
              +  Group  |          Flavor                      Image            Keep Alive  |    Cores      Disk (GBs)     RAM (MBs)    Swap (GBs)  +
              +=========+===========================+=========================+=============+=============+=============+=============+=============+
              | example | flavor-name1,flavor-name2 | image-name1,image-name2 | 60          | 2           | 10          | 2000        | 1           |
              +---------+---------------------------+-------------------------+-------------+-------------+-------------+-------------+-------------+

              Rows: 1
 
**SEE ALSO**  
       **csv2** 
       (1) **csv2_metadata** 
       (1) **csv2_group_defaults** 
       (1) **csv2_metadata_delete** 
       (1) 
       **csv2_metadata_edit** 
       (1) **csv2_metadata_list** 
       (1) **csv2_metadata_load** 
       (1) 
       **csv2_metadata_update** 
       (1) 
 
 
 
cloudscheduler version 2        7 November 2018              cloudscheduler(1)
 

.. note:: The results of an SQL query will be formatted differently from the Restructured Text tables shown above.