openstackclient package¶
Subpackages¶
- openstackclient.api package
- Submodules
 - openstackclient.api.api module
 - openstackclient.api.compute_v2 module
create_floating_ip()create_network()create_security_group()create_security_group_rule()delete_floating_ip()delete_network()delete_security_group()delete_security_group_rule()find_network()find_security_group()get_floating_ip()list_floating_ip_pools()list_floating_ips()list_networks()list_security_groups()update_security_group()
 - openstackclient.api.image_v1 module
 - openstackclient.api.image_v2 module
 - openstackclient.api.object_store_v1 module
APIv1APIv1.account_set()APIv1.account_show()APIv1.account_unset()APIv1.container_create()APIv1.container_delete()APIv1.container_list()APIv1.container_save()APIv1.container_set()APIv1.container_show()APIv1.container_unset()APIv1.object_create()APIv1.object_delete()APIv1.object_list()APIv1.object_save()APIv1.object_set()APIv1.object_show()APIv1.object_unset()
 - openstackclient.api.volume_v2 module
 - openstackclient.api.volume_v3 module
 - Module contents
 
 - openstackclient.common package
- Submodules
 - openstackclient.common.availability_zone module
 - openstackclient.common.clientmanager module
 - openstackclient.common.configuration module
 - openstackclient.common.envvars module
 - openstackclient.common.extension module
 - openstackclient.common.limits module
 - openstackclient.common.module module
 - openstackclient.common.pagination module
 - openstackclient.common.progressbar module
 - openstackclient.common.project_cleanup module
 - openstackclient.common.quota module
 - openstackclient.common.versions module
 - Module contents
 
 - openstackclient.compute package
- Subpackages
- openstackclient.compute.v2 package
- Submodules
 - openstackclient.compute.v2.agent module
 - openstackclient.compute.v2.aggregate module
 - openstackclient.compute.v2.console module
 - openstackclient.compute.v2.console_connection module
 - openstackclient.compute.v2.flavor module
 - openstackclient.compute.v2.host module
 - openstackclient.compute.v2.hypervisor module
 - openstackclient.compute.v2.hypervisor_stats module
 - openstackclient.compute.v2.keypair module
 - openstackclient.compute.v2.server module
 - openstackclient.compute.v2.server_backup module
 - openstackclient.compute.v2.server_event module
 - openstackclient.compute.v2.server_group module
 - openstackclient.compute.v2.server_image module
 - openstackclient.compute.v2.server_migration module
 - openstackclient.compute.v2.server_volume module
 - openstackclient.compute.v2.service module
 - openstackclient.compute.v2.usage module
 - Module contents
 
 
 - openstackclient.compute.v2 package
 - Submodules
 - openstackclient.compute.client module
 - Module contents
 
 - Subpackages
 - openstackclient.identity package
- Subpackages
- openstackclient.identity.v2_0 package
- Submodules
 - openstackclient.identity.v2_0.catalog module
 - openstackclient.identity.v2_0.ec2creds module
 - openstackclient.identity.v2_0.endpoint module
 - openstackclient.identity.v2_0.project module
 - openstackclient.identity.v2_0.role module
 - openstackclient.identity.v2_0.role_assignment module
 - openstackclient.identity.v2_0.service module
 - openstackclient.identity.v2_0.token module
 - openstackclient.identity.v2_0.user module
 - Module contents
 
 - openstackclient.identity.v3 package
- Submodules
 - openstackclient.identity.v3.access_rule module
 - openstackclient.identity.v3.application_credential module
 - openstackclient.identity.v3.catalog module
 - openstackclient.identity.v3.consumer module
 - openstackclient.identity.v3.credential module
 - openstackclient.identity.v3.domain module
 - openstackclient.identity.v3.ec2creds module
 - openstackclient.identity.v3.endpoint module
 - openstackclient.identity.v3.endpoint_group module
 - openstackclient.identity.v3.federation_protocol module
 - openstackclient.identity.v3.group module
 - openstackclient.identity.v3.identity_provider module
 - openstackclient.identity.v3.implied_role module
 - openstackclient.identity.v3.limit module
 - openstackclient.identity.v3.mapping module
 - openstackclient.identity.v3.policy module
 - openstackclient.identity.v3.project module
 - openstackclient.identity.v3.region module
 - openstackclient.identity.v3.registered_limit module
 - openstackclient.identity.v3.role module
 - openstackclient.identity.v3.role_assignment module
 - openstackclient.identity.v3.service module
 - openstackclient.identity.v3.service_provider module
 - openstackclient.identity.v3.tag module
 - openstackclient.identity.v3.token module
 - openstackclient.identity.v3.trust module
 - openstackclient.identity.v3.unscoped_saml module
 - openstackclient.identity.v3.user module
 - Module contents
 
 
 - openstackclient.identity.v2_0 package
 - Submodules
 - openstackclient.identity.client module
 - openstackclient.identity.common module
add_group_domain_option_to_parser()add_inherited_option_to_parser()add_project_domain_option_to_parser()add_resource_option_to_parser()add_role_domain_option_to_parser()add_user_domain_option_to_parser()find_domain()find_domain_id_sdk()find_group()find_group_id_sdk()find_project()find_service()find_service_in_list()find_service_sdk()find_user()find_user_id_sdk()get_resource()get_resource_by_id()
 - Module contents
 
 - Subpackages
 - openstackclient.image package
- Subpackages
- openstackclient.image.v1 package
 - openstackclient.image.v2 package
- Submodules
 - openstackclient.image.v2.cache module
 - openstackclient.image.v2.image module
 - openstackclient.image.v2.info module
 - openstackclient.image.v2.metadef_namespaces module
 - openstackclient.image.v2.metadef_objects module
 - openstackclient.image.v2.metadef_properties module
 - openstackclient.image.v2.metadef_resource_type_association module
 - openstackclient.image.v2.metadef_resource_types module
 - openstackclient.image.v2.task module
 - Module contents
 
 
 - Submodules
 - openstackclient.image.client module
 - Module contents
 
 - Subpackages
 - openstackclient.network package
- Subpackages
- openstackclient.network.v2 package
- Submodules
 - openstackclient.network.v2.address_group module
 - openstackclient.network.v2.address_scope module
 - openstackclient.network.v2.default_security_group_rule module
 - openstackclient.network.v2.floating_ip module
 - openstackclient.network.v2.floating_ip_pool module
 - openstackclient.network.v2.floating_ip_port_forwarding module
 - openstackclient.network.v2.ip_availability module
 - openstackclient.network.v2.l3_conntrack_helper module
 - openstackclient.network.v2.local_ip module
 - openstackclient.network.v2.local_ip_association module
 - openstackclient.network.v2.ndp_proxy module
 - openstackclient.network.v2.network module
 - openstackclient.network.v2.network_agent module
 - openstackclient.network.v2.network_auto_allocated_topology module
 - openstackclient.network.v2.network_flavor module
 - openstackclient.network.v2.network_flavor_profile module
 - openstackclient.network.v2.network_meter module
 - openstackclient.network.v2.network_meter_rule module
 - openstackclient.network.v2.network_qos_policy module
 - openstackclient.network.v2.network_qos_rule module
 - openstackclient.network.v2.network_qos_rule_type module
 - openstackclient.network.v2.network_rbac module
 - openstackclient.network.v2.network_segment module
 - openstackclient.network.v2.network_segment_range module
 - openstackclient.network.v2.network_service_provider module
 - openstackclient.network.v2.network_trunk module
 - openstackclient.network.v2.port module
 - openstackclient.network.v2.router module
 - openstackclient.network.v2.security_group module
 - openstackclient.network.v2.security_group_rule module
 - openstackclient.network.v2.subnet module
 - openstackclient.network.v2.subnet_pool module
 - Module contents
 
 
 - openstackclient.network.v2 package
 - Submodules
 - openstackclient.network.client module
 - openstackclient.network.common module
NetDetectionMixinNetDetectionMixin.appNetDetectionMixin.enhance_help_neutron()NetDetectionMixin.enhance_help_nova_network()NetDetectionMixin.get_parser()NetDetectionMixin.is_docs_buildNetDetectionMixin.is_neutronNetDetectionMixin.is_nova_networkNetDetectionMixin.split_help()NetDetectionMixin.take_action()NetDetectionMixin.take_action_compute()NetDetectionMixin.take_action_network()NetDetectionMixin.update_parser_common()NetDetectionMixin.update_parser_compute()NetDetectionMixin.update_parser_network()
NetworkAndComputeCommandNetworkAndComputeDeleteNetworkAndComputeListerNetworkAndComputeShowOneNeutronCommandWithExtraArgsNeutronUnsetCommandWithExtraArgscheck_missing_extension_if_error()
 - openstackclient.network.utils module
 - Module contents
 
 - Subpackages
 - openstackclient.object package
 - openstackclient.volume package
- Subpackages
- openstackclient.volume.v2 package
- Submodules
 - openstackclient.volume.v2.backup_record module
 - openstackclient.volume.v2.consistency_group module
 - openstackclient.volume.v2.consistency_group_snapshot module
 - openstackclient.volume.v2.qos_specs module
 - openstackclient.volume.v2.service module
 - openstackclient.volume.v2.volume module
 - openstackclient.volume.v2.volume_backend module
 - openstackclient.volume.v2.volume_backup module
 - openstackclient.volume.v2.volume_host module
 - openstackclient.volume.v2.volume_snapshot module
 - openstackclient.volume.v2.volume_transfer_request module
 - openstackclient.volume.v2.volume_type module
 - Module contents
 
 
 - openstackclient.volume.v2 package
 - Submodules
 - openstackclient.volume.client module
 - Module contents
 
 - Subpackages
 
Submodules¶
openstackclient.i18n module¶
openstackclient.shell module¶
Command-line interface to the OpenStack APIs
- class openstackclient.shell.OpenStackShell¶
 Bases:
OpenStackShell- build_option_parser(description, version)¶
 Return an argparse option parser for this application.
Subclasses may override this method to extend the parser with more global options.
- Parameters:
 description (str) – full description of the application
version (str) – version number for the application
argparse_kwargs – extra keyword argument passed to the ArgumentParser constructor
- initialize_app(argv)¶
 Global app init bits:
set up API versions
validate authentication info
authenticate against Identity if requested
- openstackclient.shell.main(argv=None)¶