Skip to content

CLI Documentation


##

COMMAND: 
     get_total_usage
NAME:
    - --filter=<[]STRING> --json

USAGE:
    [command options] [arguments...]

OPTIONS:
   --json          
   --filter value  


##

COMMAND: 
     get_racks
NAME:
    - Get a list of racks.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get a list of racks.
  Example:
  osd get_racks

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_rack
NAME:
    - Get the information of the rack.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the information of the rack.
  Example:
  osd get_rack --id=20

OPTIONS:
   --json          Return the output as json.
   --id value      The ID of the rack in an integer format.
   --filter value  Filter the values you want to see from the output.
   --nodes         Get list of the NexVisors.


##

COMMAND: 
     edit_rack
NAME:
    - Edit rack based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Edit rack based on the ID.
  Example:
  osd edit_rack --id=20 --name="new_name" --chassis='[{"id":"1","position":1}]'

OPTIONS:
   --json           Return the output as json.
   --id value       The ID of the rack in an integer format.
   --name value     The display name of the object.
   --units value    The units. (default: 0)
   --chassis value  The chassis.


##

COMMAND: 
     create_rack
NAME:
    - Create a new rack.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Create a new rack.
  Example:
  osd create_rack --name="rack name" --units=32 --order=1

OPTIONS:
   --json          Return the output as json.
   --name value    The display name of the object.
   --units value   The units it is containing. (default: 0)
   --order value   The order. (default: 0)
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     delete_rack
NAME:
    - Delete a rack based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete a rack based on the ID.
  Example:
  osd delete_rack --id=20

OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the rack in an integer format.


##

COMMAND: 
     get_nodes
NAME:
    - Get list of NexVisors.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get list of NexVisors.
  Example:
  osd get_nodes

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.
   --if value      Don't show objects if the value is true.
   --if-not value  Don't show objects if the value is false.
   --refresh       Returns the newest data on the nodes.


##

COMMAND: 
     get_node
NAME:
    - Get a NexVisor based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get a NexVisor based on the ID.
  Example:
  osd get_node --id=222


OPTIONS:
   --json          Return the output as json.
   --id value      The ID of the NexVisor in a string format.
   --filter value  Filter the values you want to see from the output.
   --sockets       Information about the NUMA socket of the NexVisor.
   --cores         List of the cores.
   --groups        List of the resource groups that use the cores of the NexVisor.
   --instances     List of the instances running on the NexVisor.
   --refresh       Returns the newest data on the node.


##

COMMAND: 
     update_node
NAME:
    - Update the name and the rack of the NexVisor based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Update the name and the rack of the NexVisor based on the ID.
  Example:
  osd update_node --id=223 --name="New name" --rack_id=3 --unit_id=1

OPTIONS:
   --json           Return the output as json.
   --id value       The ID of the NexVisor in a string format.
   --name value     The display name of the object.
   --rack_id value  The ID of the rack in an integer format. (default: 0)
   --unit_id value  The unit's ID. (default: 0)


##

COMMAND: 
     delete_node
NAME:
    - Delete inactive NexVisor based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete inactive NexVisor based on the ID.
  Example:
  osd delete_node --id=222

OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the NexVisor in a string format.


##

COMMAND: 
     get_device
NAME:
    - --path_id=<STRING> (or --vendor_id=<STRING> --device_id=<STRING>) --json

USAGE:
    [command options] [arguments...]

OPTIONS:
   --json             
   --path_id value    
   --vendor_id value  
   --device_id value  


##

COMMAND: 
     set_device
NAME:
    - --path_id=<STRING> (or --vendor_id=<STRING> --device_id=<STRING>) --bandwidth=<FLOAT> --latency=<FLOAT> --json

USAGE:
    [command options] [arguments...]

OPTIONS:
   --json             
   --path_id value    
   --bandwidth value  (default: 0)
   --latency value    (default: 0)
   --vendor_id value  
   --device_id value  


##

COMMAND: 
     get_cluster_types
NAME:
    - Get the list of cluster types.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the list of cluster types.
  Example:
  osd get_cluster_types

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     create_cluster
NAME:
    - Create a new Cluster of Instances.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Create a new cluster of instances.
  Example:
  osd create_cluster --name=”Cluster Swarm” --flavor_id=e855319a-fc46-44cb-9fcd-d0660041b9b0  --image_id=2b27ae31-38d9-4cec-a851-91735cbb634f --network_ids=1 --group_id=3 --disk_dt=fjxi3vnzg4hm9y --cluster_type=vm --number_nodes=3 


OPTIONS:
   --json                                  Return the output as json.
   --name value                            The display name of the object.
   --description value                     The description of the object.
   --flavor_id value                       The ID of the flavor in UUID format.
   --image_id value                        The ID of the image in UUID format.
   --network_ids value                     The list of network IDs.
   --group_id value                        The resource group ID. (default: 0)
   --disk_dt value                         The datastore's ID that we will use for the root disk.
   --swap_dt value                         The datastore's ID that we will use for the swap disk.
   --ephemeral_dt value                    The datastore's ID that we will use for the ephemeral disk.
   --number_nodes value                    The number of instances we need for the cluster. (default: 0)
   --use_reserved                          It will allow to use reserved resources.
   --cluster_type value                    The type of the cluster. The values are:
                                               'vm' for instances without any connection.
                                               'docker' for instances with docker inside.
                                               'swarm' for instances that communicate to each other using docker swarm.
   --install_admin_ui                      Enable the admin UI of the instance.
   --number_managers value                 Number of managers in a cluster type of swarm. (default: 0)
   --disable_storage_latency_optimization  This attribute will be used when creating an instance to prioritize the NexVisor that has
                                               at least one local physical disk from the selected datastore.
   --filter value                          Filter the values you want to see from the output.


##

COMMAND: 
     get_cluster
NAME:
    - Get a cluster.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get a cluster.
  Example:
  osd get_cluster --id=dc9a0db7-e5da-4539-a5e1-fb1957750cf5


OPTIONS:
   --json          Return the output as json.
   --id value      The ID of the cluster in UUID format.
   --instances     To list the instances of the cluster.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_clusters
NAME:
    - Get the list of clusters.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the list of clusters.
  Example:
  osd get_clusters

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     delete_cluster
NAME:
    - Delete the cluster with its instances.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete the cluster with its instances.
  Example:
  osd delete_cluster --id=dc9a0db7-e5da-4539-a5e1-fb1957750cf5

OPTIONS:
   --json          Return the output as json.
   --id value      The ID of the cluster in UUID format.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     add_instance_cluster
NAME:
    - Add an instance to the cluster.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Add an instance to the cluster.
  Example:
  osd add_instance_cluster --id=dc9a0db7-e5da-4539-a5e1-fb1957750cf5 --worker

OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the cluster in UUID format.
   --worker    If the Cluster is type of swarm then decide if the instance will be a worker.
   --manager   If the Cluster is type of swarm then decide if the instance will be a manager.


##

COMMAND: 
     on_cluster_stats
NAME:
    - Gets the websocket's messages for the cluster.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Gets the websocket's messages for the cluster.

OPTIONS:
   --id value  The ID of the cluster in UUID format.


##

COMMAND: 
     get_instances
NAME:
    - Get list of instances.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get list of instances.
  Example:
  osd get_instances

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.
   --zip value     Zip creates tuples of the choosen values.


##

COMMAND: 
     get_instance
NAME:
    - Get an instance based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get an instance based on the ID.
  Example:
  osd get_instance --id=168 


OPTIONS:
   --json          Return the output as json.
   --id value      The ID of the instance in UUID format.
   --addresses     List the network addresses.
   --interfaces    List the network interfaces.
   --volumes       List the volumes.
   --logs          List the action logs
   --filter value  Filter the values you want to see from the output.
   --if value      Don't show objects if the value is true.
   --if-not value  Don't show objects if the value is false.


##

COMMAND: 
     get_instance_creds
NAME:
    - Get instance's credentials.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get instance's credentials.
  Example:
  osd get_instance_creds --id=168
  password=5s9ov23hPph2chw5xRMD 
  result=SUCCESS 
  username=ubuntu 


OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the instance in UUID format.


##

COMMAND: 
     set_instance_creds
NAME:
    - Set instance's credentials.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Set instance's credentials.
  Example:
  osd set_instance_creds --id=168
  result=SUCCESS 


OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the instance in UUID format.


##

COMMAND: 
     set_instance_state
NAME:
    - Set instance's state based on ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Set instance's state based on ID.
  Example:
  osd set_instance_state --id=168 --state=active
  result=SUCCESS


OPTIONS:
   --json         Return the output as json.
   --id value     The ID of the instance in UUID format.
   --state value  The instance's state that has to be 'active' or 'error'


##

COMMAND: 
     create_instance
NAME:
    - Create an instance.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Create an instance.
  Example:
  osd create_instance --name=test --flavor_id=e855319a-fc46-44cb-9fcd-d0660041b9b0  --image_id=2b27ae31-38d9-4cec-a851-91735cbb634f --network_ids=1 --group_id=3 --datastores=fjxi3vnzg4hm9y --filter=id,result
  id=8
  result=SUCCESS


OPTIONS:
   --json                                  Return the output as json.
   --name value                            The display name of the instance
   --flavor_id value                       The ID of the flavor in UUID format
   --image_id value                        The ID of the image in UUID format
   --network_ids value                     The list of network interfaces based on the network's IDs
   --group_id value                        The ID of the resource group. (default: 0)
   --node_id value                         Specify the NexVisor to deploy.
   --user_data value                       Specify the file for the cloud-init's user-data.
   --meta_data value                       Specify the file for the cloud-init's meta-data.
   --disk value                            The datastore's ID for the root's disk.
   --swap value                            The datastore's ID for the swap's disk.
   --ephemeral value                       The datastore's ID for the ephemeral's disk.
   --module_id value                       The ID for the combination of modules.
   --hostname value                        
   --boot_parameters value                 The boot parameters that instance will use to run.
   --keypairs value                        The list of keypair's IDs
   --use_reserved                          It will allow to use reserved resources.
   --disable_storage_latency_optimization  This attribute will be used when creating an instance to prioritize the NexVisor that has
                                               at least one local physical disk from the selected datastore.
   --filter value                          Filter the values you want to see from the output.


##

COMMAND: 
     delete_instance
NAME:
    - Delete instance based on ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete instance based on ID.
  Example:
  osd delete_instance --id=168
  result=SUCCESS


OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the instance in UUID format.


##

COMMAND: 
     act_instance
NAME:
    - Run an action for the instance, based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Run an action for the instance, based on the ID.
  The actions that can be run are 'start', 'stop', 'destroy', 'pause','unpause' and 'reboot'.
  If the instance is in a cluster of type docker then we can also run 'restart_docker','promote','demote'.
  Example:
  osd act_instance --id=168 --action=stop


OPTIONS:
   --json           Return the output as json.
   --id value       The ID of the instance in UUID format.
   --action value   The action for the instance <'start'|'stop'|'destroy'|'pause'|'unpause'|'reboot'>
   --node_id value  
   --filter value   


##

COMMAND: 
     add_interface
NAME:
    - Add a network interface to the instance based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Add a network interface to the instance based on the ID.
  Example:
  osd add_interface --instance_id=168 --network_id=2

OPTIONS:
   --json               Return the output as json.
   --instance_id value  The ID of the instance in UUID format. (default: 0)
   --network_id value   The network's ID (default: 0)


##

COMMAND: 
     remove_interface
NAME:
    - Remove a network interface from the instance.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Remove a network interface from the instance.
  The list of instance's interfaces can be received by using osd get_instane --id=<INT> --interfaces
  Example:
  osd remove_interface --instance_id=168 --interface_id=2

OPTIONS:
   --json                Return the output as json.
   --instance_id value   The ID of the instance in UUID format. (default: 0)
   --interface_id value  The interface's ID of the instance (default: 0)


##

COMMAND: 
     get_interface
NAME:
    - Get the information for specific network interface.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the information for specific network interface.
  Example:
  osd get_interface --instance_id=168 --interface_id=145


OPTIONS:
   --json                Return the output as json.
   --instance_id value   The ID of the instance in UUID format. (default: 0)
   --interface_id value  The network's interface ID. (default: 0)


##

COMMAND: 
     migrate_instance
NAME:
    - Migrate an instance to a different NexVisor.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Migrate an instance to a different NexVisor.
  osd migrate_instance --id=1 --dest_node_id=nexvisor_id --restart


OPTIONS:
   --json                
   --id value            
   --dest_node_id value  
   --restart             


##

COMMAND: 
     get_nodes_instance_migration
NAME:
    - Get the list of nodes that from the resource group of the instance to migrate the instance.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the list of nodes that from the resource group of the instance to migrate the instance.
  osd get_nodes_instance_migration --id=1 


OPTIONS:
   --json      
   --id value  


##

COMMAND: 
     get_groups
NAME:
    - Get list of groups.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get list of groups.
  Example:
  osd get_groups

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.
   --if-not value  Don't show objects if the value is false.
   --if value      Don't show objects if the value is true.


##

COMMAND: 
     get_group
NAME:
    - Get a group

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get a group.
  Example:
  osd get_group --id=2

OPTIONS:
   --json          Return the output as json.
   --id value      The ID of the resource group in an integer format.
   --filter value  Filter the values you want to see from the output.
   --cores         List the cores of the group.
   --networks      List the networks of the group.
   --nodes         List the NexVisors of the group.
   --disks         List the storage disks of the group.
   --datastores    List the datastores of the group.
   --instances     List the instances of the group.


##

COMMAND: 
     create_group
NAME:
    - Create a new group.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Create a new group.
  Example:
  osd create_group --name=super --core_ids=54424488_4,54424488_5  --network_ids=66,2 --datastores=fjxi3vnzg4hm9y


OPTIONS:
   --json                                  Return the output as json.
   --name value                            The display name of the object.
   --description value                     The description of the object.
   --core_ids value                        The list of physical cores, based on their IDs
   --network_ids value                     The list of networks, based on their IDs
   --datastores value                      The list of datastores, based on their IDs
   --overcommit_core value                 The number of VMs we can put in the cores in percent.
                                               For example 100 will let each core run two virtual cores. (default: 0)
   --disable_storage_latency_optimization  This attribute will be used when creating an instance to prioritize the NexVisor that has
                                               at least one local physical disk from the selected datastore.
   --enable_cpu_pinning                    This attribute will enable the CPU pinning for all the instances created for this group.
   --filter value                          Filter the values you want to see from the output.
   --enable_ft                             Enable the fault tolerance.
   --ft_unit value                         Choose on of the fault tolerance units: 'mvgroup', 'blade', 'chassis' and 'rack'
   --ft_max_failures value                 The number of NexVisors that are acceptable to fail. (default: 0)
   --disable_ft_auto_failover              Disable the fault tolerance's automation failover


##

COMMAND: 
     edit_group
NAME:
    - Edit a group.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Edit a group.
  Example:
  osd edit_group --id=2 --name=super --core_ids=54424488_4,54424488_5  --network_ids=66,2 --datastores=fjxi3vnzg4hm9y


OPTIONS:
   --json                                  Return the output as json.
   --id value                              The ID of the resource group in an integer format. (default: 0)
   --name value                            The display name of the object.
   --description value                     The description of the object.
   --core_ids value                        The list of physical cores, based on their IDs
   --network_ids value                     The list of networks, based on their IDs
   --datastores value                      The list of datastores, based on their IDs
   --overcommit_core value                 The number of VMs we can put in the cores in percent.
                                               For example 100 will let each core run two virtual cores. (default: 0)
   --disable_storage_latency_optimization  This attribute will be used when creating an instance to prioritize the NexVisor that has
                                               at least one local physical disk from the selected datastore.
   --filter value                          Filter the values you want to see from the output.
   --enable_ft                             Enable the fault tolerance.
   --ft_unit value                         Choose on of the fault tolerance units: 'mvgroup', 'blade', 'chassis' and 'rack'
   --ft_max_failures value                 The number of NexVisors that are acceptable to fail. (default: 0)
   --disable_ft_auto_failover              Disable the fault tolerance's automation failover


##

COMMAND: 
     delete_group
NAME:
    - Delete a group.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete a group.
  Example:
  osd delete_group --id=14

OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the resource group in an integer format.


##

COMMAND: 
     purge_group
NAME:
    - Delete the group with the instances.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete the group with the instances.
  Example:
  osd purge_group --id=16


OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the resource group in an integer format.


##

COMMAND: 
     add_network_group
NAME:
    - Add network to the group.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Add network to the group.
  Example:
  osd add_network_group --group_id=16 --network_id=13


OPTIONS:
   --json              Return the output as json.
   --group_id value    The ID of the resource group in an integer format.
   --network_id value  The ID of the network in an integer format.


##

COMMAND: 
     remove_network_group
NAME:
    - Remove network from the group.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Remove network from the group.
  Example:
  osd remove_network_group --group_id=16 --network_id=13


OPTIONS:
   --json              Return the output as json.
   --group_id value    The ID of the resource group in an integer format.
   --network_id value  The ID of the network in an integer format.


##

COMMAND: 
     add_core_group
NAME:
    - Add core to the group.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Add core to the group.
  Example:
  osd add_core_group --group_id=2 --core_id=224_0_4


OPTIONS:
   --json            Return the output as json.
   --group_id value  The ID of the resource group in an integer format.
   --core_id value   The ID of the core in a string format.


##

COMMAND: 
     remove_core_group
NAME:
    - Remove core from the group.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Remove core from the group.
  Example:
  osd remove_core_group --group_id=2 --core_id=224_0_3

OPTIONS:
   --json            
   --group_id value  
   --core_id value   


##

COMMAND: 
     add_datastore_group
NAME:
    - Add datastore to group.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Add datastore to group.
  Example:
  osd add_datastore_group --group_id=2 --datastore_id=azekfbqlv798go

OPTIONS:
   --json                Return the output as json.
   --group_id value      The ID of the resource group in an integer format.
   --datastore_id value  The ID of the datastore in a string format.


##

COMMAND: 
     remove_datastore_group
NAME:
    - Remove datastore from the group.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Remove datastore from the group.
  Example:
  osd remove_datastore_group --group_id=2 --datastore_id=azekfbqlv798go


OPTIONS:
   --json                Return the output as json.
   --group_id value      The ID of the resource group in an integer format.
   --datastore_id value  The ID of the datastore in a string format.


##

COMMAND: 
     get_keypairs
NAME:
    - Get the list of keypairs.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the list of keypairs.
  Example:
  osd get_keypairs

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_keypair
NAME:
    - Get the keypair based on the name.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the keypair based on the name.
  Example:
  osd get_keypair --name="my-key"

OPTIONS:
   --json          Return the output as json.
   --name value    The display name of the object.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     add_keypair
NAME:
    - Add a keypair.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Add a keypair.
  Example:
  osd add_keypair --name="my-key"

OPTIONS:
   --json              Return the output as json.
   --name value        The display name of the object.
   --public_key value  The SSH public key.


##

COMMAND: 
     delete_keypair
NAME:
    - Delete the keypair based on the name.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete the keypair based on the name.
  Example:
  osd delete_keypair --name="my-key"

OPTIONS:
   --json          Return the output as json.
   --name value    The display name of the object.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_cores
NAME:
    - Get the list of cores.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the list of cores.
  Example:
  osd get_cores

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_core
NAME:
    - Get the core based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the core based on the ID.
  Example:
  osd get_core --id=224_0_1

OPTIONS:
   --json          Return the output as json.
   --id value      The ID of the core in a string format.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     update_core
NAME:
    - Update a core based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Update a core based on the ID.
  Example:
  Add core in the group.
  osd update_core --id=223_0_4 --group_id=3
  Remove the core from the group. 
  osd update_core --id=223_0_4 --group_id=0

OPTIONS:
   --json            Return the output as json.
   --id value        The ID of the core in a string format.
   --group_id value  The ID of the resource group in an integer format. (default: 0)


##

COMMAND: 
     get_networks
NAME:
    - Get list of networks.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get list of networks.
  Example:
  osd get_networks

OPTIONS:
   --json          Return the output as json.
   --if value      Don't show objects if the value is true.
   --if-not value  Don't show objects if the value is false.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_network
NAME:
    - Get a network based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get a network based on the ID.
  Example:
  osd get_network --id=13

OPTIONS:
   --json          Return the output as json.
   --id value      The ID of the network in an integer format.
   --filters       Filter the values you want to see from the output.
   --paths         List the physical paths of the network.
   --vifs          List the virtual interfaces of the network.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     create_network
NAME:
    - Create a network.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Create a network.
  Example:
  osd create_network --name=test --physicals=0,1 --ip_start=100.100.14.2 --ip_end=100.100.14.200 --gateway=100.100.14.1  --cidr=100.100.14.0/24

OPTIONS:
   --json              Return the output as json.
   --name value        The display name of the object.
   --physicals value   Set all the physical interfaces you want. If it is empty then it will use all of them.
   --is_external       DHCP type is external. Default is false
   --is_routable       It will enable a tunnel for the virtual network when it is true.
   --is_static         DHCP type is static. Default is false
   --ip_start value    The IP start. If it is empty will use the default.
   --ip_end value      The IP end. If it is empty will use the default.
   --ip_version value  The IP version. The default is 4  (default: 0)
   --gateway value     The IP gateway.
   --cidr value        The CIDR.


##

COMMAND: 
     edit_network
NAME:
    - Edit a network.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Edit a network.
  Example:
  osd edit_network --id=4 --name=test --physicals=0,1 --ip_start=100.100.14.2 --ip_end=100.100.14.200 --gateway=100.100.14.1  --cidr=100.100.14.0/24

OPTIONS:
   --id value          Network's ID
   --name value        The display name of the object.
   --physicals value   Set all the physical interfaces you want. If it is empty then it will use all of them.
   --is_external       DHCP type is external. Default is false
   --is_routable       It will enable a tunnel for the virtual network when it is true.
   --is_static         DHCP type is static. Default is false
   --ip_start value    The IP start. If it is empty will use the default.
   --ip_end value      The IP end. If it is empty will use the default.
   --ip_version value  The IP version. The default is 4  (default: 0)
   --gateway value     The IP gateway.
   --cidr value        The CIDR.


##

COMMAND: 
     delete_network
NAME:
    - Delete a network based by ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete a network based by ID.
  Example: 
  osd delete_network --id=3

OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the network in an integer format.


##

COMMAND: 
     get_network_filters
NAME:
    - Get the network filters and the NexVisor.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the network filters and the NexVisor.
  Example:
  osd get_network_filters --id=2
        all_nodes=deadbaad,cafed00d 
        enabled_nodes=deadbaad 
        paths=0 
        result=SUCCESS 



OPTIONS:
   --id value  The ID of the network in an integer format.
   --json      Return the output as json.


##

COMMAND: 
     add_filter
NAME:
    - Add physical paths to the network.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Add physical paths to the network.
  Example:
  osd add_filter --network_id=2 --paths=1,3

OPTIONS:
   --json              Return the output as json.
   --network_id value  The ID of the network in an integer format.
   --paths value       Physical path's IDs.


##

COMMAND: 
     remove_filter
NAME:
    - Remove all the filters from the network.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Remove all the filters from the network.
  Example:
  osd remove_filter --network_id=38

OPTIONS:
   --json              Return the output as json.
   --network_id value  The ID of the network in an integer format.


##

COMMAND: 
     get_physical_paths
NAME:
    - Get list of the physical paths.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get list of the physical paths.
  Example:
  osd get_physical_paths

OPTIONS:
   --json  Return the output as json.


##

COMMAND: 
     get_flavors
NAME:
    - Get list of flavors.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get list of flavors.
  Example:
  osd get_flavors
  0:
    disk=3 
    ephemeral=0 
    id=f81ae426-353a-4377-b627-e20ab7dccc3d 
    name=medium 
    ram=386 
    result=SUCCESS 
    swap=0 
    vcpus=2 

  1:
    disk=8 
    ephemeral=0 
    id=c5428b33-5a25-4040-9011-9b70dd21c34c 
    name=large 
    ram=384 
    result=SUCCESS 
    swap=0 
    vcpus=1 


OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_flavor
NAME:
    - Get specific flavor based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get specific flavor based on the ID.
  Example:
  osd get_flavor --id=f81ae426-353a-4377-b627-e20ab7dccc3d
  disk=3 
  ephemeral=0 
  id=f81ae426-353a-4377-b627-e20ab7dccc3d 
  name=medium 
  ram=386 
  result=SUCCESS 
  swap=0 
  vcpus=2 


OPTIONS:
   --json          Return the output as json.
   --id value      The ID of the flavor in UUID format.
   --filter value  Return the output as json.


##

COMMAND: 
     create_flavor
NAME:
    - Create a new flavor.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Create a new flavor.
  Example:
  osd create_flavor --name="small" --ram=384 --disk=1 --cpus=1
  disk=1 
  ephemeral=0 
  id=c0009482-1d94-4eb9-b414-56e0ff332a11 
  name=small 
  ram=384 
  result=SUCCESS 
  swap=0 
  vcpus=1 


OPTIONS:
   --json             Return the output as json.
   --name value       The display name of a flavor.
   --id value         Specify the ID of the flavor.
   --ram value        The amount of RAM a flavor has, in MiB. (default: 0)
   --cpus value       The number of CPUs. (default: 0)
   --disk value       The size of the root disk in GiB (default: 0)
   --swap value       The size of the swap disk in GiB (default: 0)
   --ephemeral value  The size of the ephimeral disk in GiB (default: 0)
   --filter value     Filter the values you want to see from the output.


##

COMMAND: 
     delete_flavor
NAME:
    - Delete a flavor based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete a flavor based on the ID.
  Example:
  osd delete_flavor --id=f81ae426-353a-4377-b627-e20ab7dccc3d
  result=SUCCESS


OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the flavor in UUID format.


##

COMMAND: 
     get_images
NAME:
    - Get the list of images.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the list of images.
    Example: 
    osd get_images
    0:
      architecture=x86_64 
      cluster_type=vm 
      id=266150ea-9c7b-40fe-a56e-3363b22e4283 
      min_disk=0 
      min_ram=0 
      name=Ubuntu-16.04-LTS 
      os_distro=ubuntu 
      os_version=16.04 
      result=SUCCESS 
      size=2.86982144e+08 
      status=active 
      virtual_size=0 
      visibility=public 


OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_image
NAME:
    - Get a specific image based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get a specific image based on the ID.
  Example:
  osd get_image --id=266150ea-9c7b-40fe-a56e-3363b22e4283
  architecture=x86_64 
  cluster_type=vm 
  id=266150ea-9c7b-40fe-a56e-3363b22e4283 
  min_disk=0 
  min_ram=0 
  name=Ubuntu-16.04-LTS 
  os_distro=ubuntu 
  os_version=16.04 
  result=SUCCESS 
  size=2.86982144e+08 
  status=active 
  virtual_size=0 
  visibility=public 


OPTIONS:
   --json          Return the output as json.
   --id value      The ID of the image in UUID format.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     create_image
NAME:
    - Create a new record on the database for the image.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Create a new record on the database for the image.
  Example:
  osd create_image --name="Ubuntu Xenial" --disk=3 --container_format=bare --disk_format=qcow2 --visibility=public --arch=x86_64 --distro=ubuntu --version=16.04 --cluster_type=vm
  architecture=x86_64 
  cluster_type=vm 
  id=b926e84a-8ec9-42b4-9fbb-c34cd938d605 
  min_disk=3 
  min_ram=0 
  name=Ubuntu Xenial 
  os_distro=ubuntu 
  os_version=16.04 
  result=SUCCESS 
  size=0 
  status=queued 
  virtual_size=0 
  visibility=public 


OPTIONS:
   --json                    Return the output as json.
   --name value              Name of the image.
   --id value                Specify the ID of the image.
   --disk value              The space it needs from the volume. (default: 0)
   --ram value               The RAM it needs from the instance. (default: 0)
   --visibility value        Visibility for this image. Valid value is one of: public, private, shared, or community. (default: public)
   --container_format value  The container format of the image <ami|aki|ari|bare|ovf|ova>.
   --disk_format value       The disk format of the image <ami|ari|aki|vhd|vmdk|raw|qcow2|vdi|iso>.
   --distro value            The name of the OS's distribution.
   --cluster_type value      The type of the Cluster the image can be used <vm|docker>.
   --version value           The version of the image.
   --arch value              The architecture of the image.
   --filter value            Filter the values you want to see from the output.


##

COMMAND: 
     update_image_file
NAME:
    - Upload the image file for the specific image.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Upload the image file for the specific image.
  Example:
  osd update_image_file --id=73b2a4fc-0f6b-4048-b262-39c30636c12a --file=/root/trusty-server-cloudimg-arm64-disk1.img
  result=SUCCESS 


OPTIONS:
   --json        Return the output as json.
   --id value    The ID of the image in UUID format.
   --file value  The file of the image.


##

COMMAND: 
     delete_image
NAME:
    - Delete image based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete image based on the ID.
  Example:
  osd delete_image --id=266150ea-9c7b-40fe-a56e-3363b22e4283
  result=SUCCESS

OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the image in UUID format.


##

COMMAND: 
     get_volumes
NAME:
    - 

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get list of volumes.

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.
   --if-not value  Don't show objects if the value is false.
   --if value      Don't show objects if the value is true.


##

COMMAND: 
     get_volume
NAME:
    - Get a volume based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get a volume based on the ID.
  Example:
  osd get_volume --id=34

OPTIONS:
   --json          Return the output as json.
   --id value      The ID of the volume in an integer format.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     create_volume
NAME:
    - --name=<STRING, optional> --size=<GB> --image_id=<UUID, optional> --group_id=<INT> --filter=<[]STRING> --json

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Create new volums with specified size, name, datastore, etc.

OPTIONS:
   --json             
   --name value       
   --image_id value   
   --size value       (default: 0)
   --datastore value  
   --use_type value   
   --filter value     


##

COMMAND: 
     delete_volume
NAME:
    - Delete unused volume based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete unused volume based on the ID.
  Example:
  osd delete_volume --id=34

OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the volume in an integer format.


##

COMMAND: 
     repair_volume
NAME:
    - Repair volume based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Repair volume based on the ID.
  Example:
  osd repair_volume --id=34


OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the volume in an integer format.


##

COMMAND: 
     get_datastores
NAME:
    - Get the list of datastores.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the list of datastores.
  Example:
  osd get_datastores


OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.
   --if-not value  Don't show objects if the value is false.
   --if value      Don't show objects if the value is true.


##

COMMAND: 
     get_datastore
NAME:
    - Get a datastore based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get a datastore based on the ID.
  Example:
  osd get_datastore --id=azekfbqlv798go


OPTIONS:
   --json          Return the output as json.
   --id value      The ID of the datastore in a string format.
   --disks         List the storage disks based on the datastore.
   --volumes       List the volumes based on the datastore.
   --db_backups    List the DB backups based on the datastore.
   --filter value  Filter the values you want to see from the output.
   --if-not value  Don't show objects if the value is false.
   --if value      Don't show objects if the value is true.


##

COMMAND: 
     edit_datastore
NAME:
    - Edit a datastore based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Edit a datastore based on the ID.
  Example:
  osd edit_datastore --id=azekfbqlv798go


OPTIONS:
   --json               Return the output as json.
   --id value           The ID of the datastore in a string format.
   --name value         the name of the datastore.
   --db_metadata value  Enable a vdisk for backing up the DBs.


##

COMMAND: 
     delete_datastore
NAME:
    - Delete a datastore.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete a datastore.
  Example:
  osd delete_datastore

OPTIONS:
   --json          Return the output as json.
   --id value      The ID of the datastore in a string format.
   --safe-force    To force a delete of a datastore safely so it does not disrupt instances.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     create_datastore
NAME:
    - Create a new datastore.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Create a new datastore.
  Example:
  osd create_datastore --name=test --disks=3584916917,3283879690 --replicas=1 --thick=1

OPTIONS:
   --json                       Return the output as json.
   --name value                 The display name of the object.
   --disks value                The list of storage disk's IDs.
   --overcommit value           The overcommit value of the space that the volumes can take.
   --replicas value             The number of replicas we want for the volumes. (default: 0)
   --thick value                The attribute to make the datastore thick. (default: 0)
   --db_metadata                Enable a vdisk for backing up the DBs.
   --filter value               Filter the values you want to see from the output.
   --trigger_repair value       How to trigger the repairs when the volumes are degrated, 'periodic' or 'manual'.
   --periodic_repair_sec value  When the trigger_repair is periodic, then we can write in seconds the periods it will check the volumes. (default: 0)
   --num_of_repairs value       The number of repairs it can do in a parallel. (default: 0)


##

COMMAND: 
     add_disk_datastore
NAME:
    - Add storage disk to the datastore.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Add storage disk to the datastore.
  Example:
  osd add_disk_datastore --datastore_id=azekfbqlv798go --disk_id=1307131532

OPTIONS:
   --json                Return the output as json.
   --datastore_id value  The ID of the datastore in a string format.
   --disk_id value       The ID of the storage disk in a string format.
   --filter value        Filter the values you want to see from the output.


##

COMMAND: 
     remove_disk_datastore
NAME:
    - Remove a storage disk from the datastore.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Remove a storage disk from the datastore.
  Example:
  osd remove_disk_datastore --datastore_id=azekfbqlv798go --disk_id=1307131532

OPTIONS:
   --json                Return the output as json.
   --datastore_id value  The ID of the datastore in a string format.
   --disk_id value       The ID of the storage disk in a string format.
   --filter value        Filter the values you want to see from the output.


##

COMMAND: 
     get_db_backups
NAME:
    - Get DB backups.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get DB backups.
  Example:
  osd get_db_backups --id=<ID>

OPTIONS:
   --json  Return the output as json.


##

COMMAND: 
     restore_db_backup
NAME:
    - Restore a DB backup.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Restore a DB backup.
  Example:
  osd restore_db_backup --filename=<ID>

OPTIONS:
   --json            Return the output as json.
   --filename value  The filename of the DB backup.


##

COMMAND: 
     delete_db_backups
NAME:
    - Delete DB backups.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete DB backups.
  Example:
  osd delete_db_backups --wipe_all
  osd delete_db_backups --keep_days=2 

OPTIONS:
   --json             Return the output as json.
   --keep_days value  How many days of DB backups to keep (default: 0)
   --wipe_all         Wipe all the DB backups


##

COMMAND: 
     create_db_backup
NAME:
    - Create a new DB backup.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Create a new DB backup.
  Example:
  osd create_db_backup 

OPTIONS:
   --json  Return the output as json.


##

COMMAND: 
     sync_db_metadata
NAME:
    - Sync openstack backup files with the DB Metadata.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Sync openstack backup files with the DB Metadata..
  Example:
  osd sync_db_metadata --filename=<FILENAME>
  osd sync_db_metadata --sync 

OPTIONS:
   --json            Return the output as json.
   --filename value  Add the filename
   --sync            Sync all the DB metadata


##

COMMAND: 
     get_disks
NAME:
    - Get list of storage disks.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get list of storage disks.
  Example:
  osd get_disks

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_disk
NAME:
    - Get a storage disk based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get a storage disk based on the ID.
  Example:
  osd get_disk --id=1307131532

OPTIONS:
   --json          Return the output as json.
   --id value      The ID of the storage disk in a string format.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     delete_disk
NAME:
    - Delete a storage disk based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete a storage disk based on the ID.
  Example:
  osd delete_disk --id=1307131532

OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the storage disk in a string format.


##

COMMAND: 
     get_chassis_types
NAME:
    - Get list of chassis types.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get list of chassis types.
  Example:
  osd get_chassis_types

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_chassis_type
NAME:
    - Get a chassis type based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get a chassis type based on the ID.
  Example:
  osd get_chassis_type

OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the chassis type in an integer format.


##

COMMAND: 
     create_chassis_type
NAME:
    - Create a chassis type.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Create a chassis type.
  Example:
  osd create_chassis_type --name="Test" --description="a description" --units=32 --blades=1 --nodes_per_blade=1


OPTIONS:
   --json                            Return the output as json.
   --name value                      The display name of the object.
   --description value               The description of the object.
   --units value                     The number of units. (default: 0)
   --blades value                    The number of blades. (default: 0)
   --nodes_per_blade value           The number of NexVisor groups per blade. (default: 0)
   --physical_disks_per_blade value  The number of physical disks per blade. (default: 0)


##

COMMAND: 
     edit_chassis_type
NAME:
    - Edit chassis type.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Edit chassis type.
  Example:
  osd edit_chassis_type --name="Test" --description="a description" --units=32 --blades=1 --nodes_per_blade=1


OPTIONS:
   --json                            Return the output as json.
   --id value                        The ID of the chassis type in an integer format. (default: 0)
   --name value                      The display name of the object.
   --description value               The description of the object.
   --units value                     The number of units. (default: 0)
   --blades value                    The number of blades. (default: 0)
   --nodes_per_blade value           The number of NexVisor groups per blade. (default: 0)
   --physical_disks_per_blade value  The number of physical disks per blade. (default: 0)


##

COMMAND: 
     delete_chassis_type
NAME:
    - Delete chassis type based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete chassis type based on the ID.
  Example:
  osd delete_chassis_type --id=34

OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the chassis type in an integer format.


##

COMMAND: 
     get_chassis
NAME:
    - Get chassis based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get chassis based on the ID.
  Example:
  osd get_chassis --id=2a

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.
   --id value      The ID of the chassis in a string format.


##

COMMAND: 
     create_chassis
NAME:
    -  --rack_id=<INT> --position=<INT> --chassis_type_id=<INT>  --json

USAGE:
    [command options] [arguments...]

OPTIONS:
   --json                   
   --rack_id value          (default: 0)
   --chassis_type_id value  (default: 0)
   --position value         (default: 0)


##

COMMAND: 
     edit_chassis
NAME:
    - Edit chassis.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Edit chassis.
  Example:
  osd edit_chassis --id=3a --rack_id=3 --chassis_type_id=2

OPTIONS:
   --json                   Return the output as json.
   --rack_id value          The ID of the rack in an integer format. (default: 0)
   --position value         Change the position in the list. (default: 0)
   --chassis_type_id value  The chassis type based on the ID. (default: 0)
   --id value               


##

COMMAND: 
     delete_chassis
NAME:
    - --id=<INT>  --json

USAGE:
    [command options] [arguments...]

OPTIONS:
   --json      
   --id value  


##

COMMAND: 
     get_blade
NAME:
    - Get blade based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get blade based on the ID.
  Example:
  osd get_blade --id=29a 
  autodiscovered=true 
  blade_id=29a 
  blade_position=1 
  chassis_id=29a 
  id=29a 
  label=29a 
  nodes={avail_memory:11173,bandwidth_in:[0,0],bandwidth_out:[0,0],blade_id:29a,chassis_id:29a,committed_memory:0,committed_vcpus:0,contains_openstack:false,id:cafed00d,label:cafed00d,NexVisor:1e24209,model:,mvgroup_id:29a,rack_id:1,state:ACTIVE,total_cores:8,total_memory:12544,unit_id:0,used_cores:4,vendor:Dell      CS24-SC               ,virtual_cores:0,virtual_memory:0},{avail_memory:4407,bandwidth_in:[0,0],bandwidth_out:[0,0],blade_id:29a,chassis_id:29a,committed_memory:2304,committed_vcpus:6,contains_openstack:true,id:deadbaad,label:deadbaad,NexVisor:1e24209,model:,mvgroup_id:29a,rack_id:1,state:ACTIVE,total_cores:8,total_memory:7520,unit_id:0,used_cores:4,vendor:Dell      CS24-SC               ,virtual_cores:4,virtual_memory:1536}
  rack_id=1 
  result=SUCCESS 
  vendor=Dell 


OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.
   --id value      The blade's ID in string


##

COMMAND: 
     get_blades
NAME:
    - Get list of blades.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get list of blades.
  Example:
  0:
    autodiscovered=true 
    chassis_id=29a 
    id=29a 
    mv_groups={autodiscovered:true,blade_id:29a,blade_position:1,chassis_id:29a,id:29a,label:29a,nodes:[{avail_memory:11173,bandwidth_in:[0,0],bandwidth_out:[0,0],blade_id:29a,chassis_id:29a,committed_memory:0,committed_vcpus:0,contains_openstack:false,id:cafed00d,label:cafed00d,NexVisor:1e24209,model:,mvgroup_id:29a,rack_id:1,state:ACTIVE,total_cores:8,total_memory:12544,unit_id:0,used_cores:4,vendor:Dell      CS24-SC               ,virtual_cores:0,virtual_memory:0},{avail_memory:4407,bandwidth_in:[0,0],bandwidth_out:[0,0],blade_id:29a,chassis_id:29a,committed_memory:2304,committed_vcpus:6,contains_openstack:true,id:deadbaad,label:deadbaad,NexVisor:1e24209,model:,mvgroup_id:29a,rack_id:1,state:ACTIVE,total_cores:8,total_memory:7520,unit_id:0,used_cores:4,vendor:Dell      CS24-SC               ,virtual_cores:4,virtual_memory:1536}],rack_id:1,vendor:Dell}
    result=SUCCESS


OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_mvgroup
NAME:
    - Get information about the  Group based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get information about the NexVisor Group based on the ID.
  Example:
  osd get_mvgroup --id=2A

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.
   --id value      The ID of the NexVisor group in a string format.
   --cores         List the cores of the NexVisor group.
   --groups        List the resource groups using the NexVisor group.
   --instances     List the instances that the NexVisor group has.
   --disks         List the storage disks that the NexVisor group has.


##

COMMAND: 
     get_mvgroups
NAME:
    - Get a list of NexVisor groups.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get a list of NexVisor groups.
  Example:
  osd get_mvgroups

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_alerts
NAME:
    - Get list of alert.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get list of alert.
  Example:
  osd get_alerts

OPTIONS:
   --json          Return the output as json.
   --hide          List the hidden alerts.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     hide_alert
NAME:
    - Hide alert from the list.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Hide alert from the list.
  Example:
  osd hide_alert

OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the alert in an integer format.


##

COMMAND: 
     delete_alert
NAME:
    - Delete an alert based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete an alert based on the ID.
  Example:
  osd delete_alert --id=32

OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the alert in an integer format.


##

COMMAND: 
     enable_websocket
NAME:
    - --channel=<STRING>  --message=<STRING> 
  Example
  osd enable_websocket --channel="currentPage" --message='{"page":"/mvgroups?mvGroupId=11a31"}'


USAGE:
    [command options] [arguments...]

OPTIONS:
   --channel value  
   --message value  


##

COMMAND: 
     create_alert
NAME:
    -  --title=<STRING> --text=<STRING> --type=<STRING> --subtype=<STRING> --level=<warning|success|failure> --id=<STRING> --json

USAGE:
    [command options] [arguments...]

OPTIONS:
   --json           
   --title value    
   --text value     
   --type value     
   --id value       
   --subtype value  
   --level value    


##

COMMAND: 
     get_stats_instances
NAME:
    - Get a list for all the stats from all the instances.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get a list for all the stats from all the instances.
  Example:
  osd get_stats_instances

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_stats_instance
NAME:
    - Get stats for one instance based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get a list for all the instances.
  Example:
  osd get_stats_instances

OPTIONS:
   --json          Return the output as json.
   --id value      The ID of the instance in UUID format.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_stats_resources
NAME:
    - Get the stats for all the resources.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the stats for all the resources.
  Example:
  osd get_stats_resources

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     create_user
NAME:
    - Create a user.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Create a user.
  Example:
  osd create_user --name="Johny" --password="Walker" --project_id=e4c2e7641b0f4000942bb9d8c2a384c5 --role_id=40962f92835144c9a7bfeb0db3c21946


OPTIONS:
   --json              Return the output as json.
   --name value        The display name of the object.
   --project_id value  The ID of the user's project.
   --role_id value     The ID of the user's role.
   --password value    The password.
   --filter value      Filter the values you want to see from the output.


##

COMMAND: 
     delete_user
NAME:
    - Delete the user based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete the user based on the ID.
  Example:
  osd delete_user --id=fb4bf2aee44849fbb6bb892657652b19

OPTIONS:
   --json      Return the output as json.
   --id value  The ID of the user in a string format.


##

COMMAND: 
     get_users
NAME:
    - Get list of users.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get list of users.
  Example:
  osd get_users


OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_roles
NAME:
    - Get the user's roles.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the user's roles.
  Example:
  osd get_roles

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_projects
NAME:
    - Get the list of user's projects.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the list of user's projects.
  Example:
  osd get_projects

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     enable_websocket
NAME:
    - --channel=<STRING>  --message=<STRING> 
  Example
  osd enable_websocket --channel="currentPage" --message='{"page":"/mvgroups?mvGroupId=11a31"}'


USAGE:
    [command options] [arguments...]

OPTIONS:
   --channel value  
   --message value  


##

COMMAND: 
     get_manifest
NAME:
    - List all the versions.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   List all the versions.
  osd get_manifest

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_system_info
NAME:
    - Get system info and fault tolerance list.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get system type and fault tolerance list.
  osd get_system_info

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     change_my_password
NAME:
    - Change my password.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Change my password.
  Example:
  osd change_my_password --old_password=<old pass> --new_password=<new pass>

OPTIONS:
   --json                Return the output as json.
   --old_password value  The old password.
   --new_password value  The new password.
   --filter value        Filter the values you want to see from the output.


##

COMMAND: 
     get_me
NAME:
    - Get information about me

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Change my password.
  Example:
  osd get_me

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_modules
NAME:
    - Get the list of modules.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the list of modules.

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_module
NAME:
    - Get module.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get module.

OPTIONS:
   --id value  The modules combination ID


##

COMMAND: 
     get_image_modules
NAME:
    - Get the list of modules by image.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get the list of modules.

OPTIONS:
   --id value      The image ID
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     create_module
NAME:
    - Create a combination of modules.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Create a combination of modules.

OPTIONS:
   --label value      The label
   --image_ids value  The image IDs.


##

COMMAND: 
     delete_module
NAME:
    - Delete specific modules combination based on the ID.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete specific modules combination based on the ID.

OPTIONS:
   --id value  The module's ID


##

COMMAND: 
     default_module
NAME:
    - Set the default modules to a specific image.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Set the default modules to a specific image.

OPTIONS:
   --image_id value   The image ID
   --module_id value  The module's ID


##

COMMAND: 
     upload_kernel_file
NAME:
    - Upload the kernel file for the specific module.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Upload the image file for the specific image.
  Example:
  osd upload_kernel_file --id=73b2a4fc-0f6b-4048-b262-39c30636c12a --file=kernel_file
  result=SUCCESS 


OPTIONS:
   --json        Return the output as json.
   --id value    The modules combination ID.
   --file value  The file of the module.


##

COMMAND: 
     upload_initrd_file
NAME:
    - Upload the initrd file for the specific module.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Upload the image file for the specific image.
  Example:
  osd upload_initrd_file --id=73b2a4fc-0f6b-4048-b262-39c30636c12a --file=initrd_file
  result=SUCCESS 


OPTIONS:
   --json        Return the output as json.
   --id value    The modules combination ID.
   --file value  The file of the module.


##

COMMAND: 
     get_services
NAME:
    - List all the services with their states.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   List all the services with their states.
  osd get_services

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_system_info
NAME:
    - Get system info and fault tolerance list.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get system type and fault tolerance list.
  osd get_system_info

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_support_session
NAME:
    - osd get_support_session

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get information about the current running support.

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     create_support_session
NAME:
    - osd create_support_session

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Create a support session.

OPTIONS:
   --json  Return the output as json.


##

COMMAND: 
     delete_support_session
NAME:
    - osd delete_support_session

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete the current running support session

OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     get_latest_license
NAME:
    - Get latest license.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get latest license.
  Example:
  osd get_latest_license


OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.


##

COMMAND: 
     add_license
NAME:
    - Add license.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Get list of licenses.
  Example:
  osd get_licenses


OPTIONS:
   --json                Return the output as json.
   --filter value        Filter the values you want to see from the output.
   --license_file value  The file of the license.


##

COMMAND: 
     delete_latest_license
NAME:
    - Delete latest license.

USAGE:
    [command options] [arguments...]

DESCRIPTION:
   Delete license.
  Example:
  osd delete_latest_license 


OPTIONS:
   --json          Return the output as json.
   --filter value  Filter the values you want to see from the output.