CLI Documentation
NAME:
oadoscli - CLI for OnApp Dashboard's Openstack
USAGE:
osd [global options] command [command options] [arguments...]
VERSION:
0.2
COMMANDS:
Block Devices
get_blockdevs Get list of block devices.
get_blockdev Get block device based on the UUID.
init_blockdev Initialize block device based on UUID.
Build Info
get_build_info Get the build info of Sunlight system.
Racks
get_racks Get a list of racks.
get_rack Get the information of the rack.
edit_rack Edit rack based on the ID.
create_rack Create a new rack.
delete_rack Delete a rack based on the ID.
Nodes
get_nodes Get list of NexVisors.
get_node Get a NexVisor based on the ID.
update_node Update the name and the rack of the NexVisor based on the ID.
delete_node Delete inactive NexVisor based on the ID.
act_node Run an action for the current node, based on the ID.
Clusters
get_cluster_types Get the list of cluster types.
create_cluster Create a new Cluster of Instances.
get_cluster Get a cluster.
get_clusters Get the list of clusters.
delete_cluster Delete the cluster with its instances.
add_instance_cluster Add an instance to the cluster.
on_updating_cluster Gets the websocket's messages for the clusters.
on_cluster_stats Gets the websocket's messages for the cluster.
Certifications
get_certification Get a certification based on the ID.
get_certifications Get a certifications.
add_certification Add a new certification.
edit_certification Edit certification based on ID.
delete_certification Delete a certification based on the ID.
Instances
get_instances Get list of instances.
get_instance Get an instance based on the ID.
get_instance_creds Get instance's credentials.
set_instance_creds Set instance's credentials.
set_instance_state Set instance's state based on ID.
on_updating_instance Gets the websocket's messages for the instances.
create_instance Create an instance.
delete_instance Delete instance based on ID.
act_instance Run an action for the instance, based on the ID.
get_datastores_instance Get list of available datastores of instance.
get_flavors_instance Get list of flavors available for instance for resizing.
resize_instance Resize the characteristics of instance using a different flavor.
add_interface Add a network interface to the instance based on the ID.
remove_interface Remove a network interface from the instance.
get_interface Get the information for specific network interface.
migrate_instance Migrate an instance to a different NexVisor.
get_nodes_instance_migration Get the list of nodes that from the resource group of the instance to migrate the instance.
update_interface Update the IP of an interface.
attach_cdrom Attach a CDROM to an instance
detach_cdrom Detach a CDROM to an instance
Resource groups
get_groups Get list of groups.
get_group Get a group
create_group Create a new group.
edit_group Edit a group.
delete_group Delete a group.
purge_group Delete the group with the instances.
add_network_group Add network to the group.
remove_network_group Remove network from the group.
add_core_group Add core to the group.
remove_core_group Remove core from the group.
add_datastore_group Add datastore to group.
remove_datastore_group Remove datastore from the group.
Keypairs
get_keypairs Get the list of keypairs.
get_keypair Get the keypair based on the name.
add_keypair Add a keypair.
delete_keypair Delete the keypair based on the name.
Cores
get_cores Get the list of cores.
get_core Get the core based on the ID.
update_core Update a core based on the ID.
Networks
get_networks Get list of networks.
get_network Get a network based on the ID.
create_network Create a network.
edit_network Edit a network.
delete_network Delete a network based by ID.
get_network_filters Get the network filters and the NexVisor.
add_filter Add physical paths to the network.
remove_filter Remove all the filters from the network.
get_physical_paths Get list of the physical paths.
get_network_ips Get the IPs of a network based on the ID.
Flavors
get_flavors Get list of flavors.
get_flavor Get specific flavor based on the ID.
create_flavor Create a new flavor.
delete_flavor Delete a flavor based on the ID.
Images
get_images Get the list of images.
get_image Get a specific image based on the ID.
create_image Create a new record on the database for the image.
update_image_file Upload the image file for the specific image.
refresh_images Refresh the Image list from the repo.
download_image_file Download the image file for the specific image.
enable_image Enable the Image for a specific ID
disable_image Disable the Image for a specific ID
delete_image Delete image based on the ID.
get_storage_avail Get storage availability.
Repositories
get_repos Get the list of repositories.
get_repo Get a specific repo based on the ID.
create_repo Create a new record on the database for the repository.
delete_repo Delete repo based on the ID.
Volumes
get_volumes
get_volume Get a volume based on the ID.
delete_volume Delete unused volume based on the ID.
repair_volume Repair volume based on the ID.
Datastores
get_datastores Get the list of datastores.
get_datastore Get a datastore based on the ID.
edit_datastore Edit a datastore based on the ID.
delete_datastore Delete a datastore.
create_datastore Create a new datastore.
add_disk_datastore Add storage disk to the datastore.
remove_disk_datastore Remove a storage disk from the datastore.
get_db_backups Get DB backups.
restore_db_backup Restore a DB backup.
delete_db_backups Delete DB backups.
create_db_backup Create a new DB backup.
sync_db_metadata Sync openstack backup files with the DB Metadata.
Disks
get_disks Get list of storage disks.
get_disk Get a storage disk based on the ID.
delete_disk Delete a storage disk based on the ID.
timesync
Chassis Types
get_chassis_types Get list of chassis types.
get_chassis_type Get a chassis type based on the ID.
create_chassis_type Create a chassis type.
edit_chassis_type Edit chassis type.
delete_chassis_type Delete chassis type based on the ID.
Chassis
get_chassis Get chassis based on the ID.
edit_chassis Edit chassis.
Blades
get_blade Get blade based on the ID.
get_blades Get list of blades.
MvGroups
get_mvgroup Get information about the Group based on the ID.
get_mvgroups Get a list of NexVisor groups.
Alerts
get_alerts Get list of alert.
hide_alert Hide alert from the list.
delete_alert Delete an alert based on the ID.
on_alert Waiting to print new alerts.
Stats
get_stats_instances Get a list for all the stats from all the instances.
get_stats_instance Get stats for one instance based on the ID.
get_stats_resources Get the stats for all the resources.
Users
create_user Create a user.
delete_user Delete the user based on the ID.
get_users Get list of users.
get_roles Get the user's roles.
get_projects Get the list of user's projects.
get_system_info Get system info and fault tolerance list.
change_my_password Change my password.
get_me Get information about me
Modules
get_modules Get the list of modules.
get_module Get module.
get_image_modules Get the list of modules by image.
create_module Create a combination of modules.
delete_module Delete specific modules combination based on the ID.
default_module Set the default modules to a specific image.
upload_kernel_file Upload the kernel file for the specific module.
upload_initrd_file Upload the initrd file for the specific module.
System type
get_system_info Get system info and fault tolerance list.
SupportSession
get_support_session osd get_support_session
create_support_session osd create_support_session
delete_support_session osd delete_support_session
Licenses
get_latest_license Get latest license.
add_license Add license.
delete_latest_license Delete latest license.
all_help Get all the subcommand helps
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help, -h show help
--version, -v print the version