man(1) page: cloudscheduler metadata load¶
- NAME
- cloudscheduler metadata load - add group metadata to cloudscheduler version 2 (csv2) servers
- SYNOPSIS
- cloudscheduler metadata load -f file -mn name [ options …]
- DESCRIPTION
- The cloudscheduler metadata load action loads group metadata from csv2 servers. This action is available to all users, provided they are in the group that the metadata belongs to. Priviliged users may also use the cloudscheduler group metadata-load command.
- OPTIONS
- Mandatory
The following are mandatory parameters and must be specified:
- -f file, --file-path file
- The file to be added as a metadata file. The value of file should be an absolute path to the file to be added.
- -mn name, --metadata-name name
- The metadata name and primary identifier. The value for name must be all lower case, numeric digits, and dashes but cannot start or end with dashes..
- Optional
The following are optional parameters:
- -F , --force
- Specify this option to override non-critical errors. For example, cloudscheduler commands to load metedata are implicitly adding a new objects to CSV2; if the specified objects already exist, such commands fail with an error message. In these situations, the “–force” option changes the implicit add to an implicit “update” and the commands succeed.
- -me option, --metadata-enabled option
- Sets if this metadata is to be applied to VMs started in this cloud. The value for option must be one of true , false , yes , no , 1 , or 0 . Default: 1
- -mmt type, --metadata-mime-type type
- Value specified for type must be one of the following options: cloud-config or ucernvm-config . Default: cloud-config
- -mp priority, --metadata-priority priority
- The priority of the metadata file. Specifes the order in which metadata files are sent to VMs. The value of priority must be an integer. Default: 0
- 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
- Adding the group metadata “example”: $ cloudscheduler metadata load -f /<path>/example.yaml -mn example.yaml -me true -mmt ucernvm-config -mp 4 group metadata file “example::example.yaml” successfully added.
- SEE ALSO
- csv2 (1) csv2_group_metadata-load (1) csv2_metadata_group-defaults (1) csv2_metadata_delete (1) csv2_metadata_edit (1) csv2_metadata_list (1) csv2_metadata_update (1)
cloudscheduler version 2 7 November 2018 cloudscheduler(1)