openstackclient.network.client.
build_option_parser
(parser)¶Hook to add global options
openstackclient.network.client.
make_client
(instance)¶Returns a network proxy
openstackclient.network.common.
NetDetectionMixin
¶Bases: object
Convenience methods for nova-network vs. neutron decisions.
A live environment detects which network type it is running and creates its parser with only the options relevant to that network type.
But the command classes are used for docs builds as well, and docs must present the options for both network types, often qualified accordingly.
enhance_help_neutron
(_help)¶enhance_help_nova_network
(_help)¶get_parser
(prog_name)¶is_docs_build
¶is_neutron
¶is_nova_network
¶split_help
(network_help, compute_help)¶take_action
(parsed_args)¶take_action_compute
(client, parsed_args)¶Override to do something useful.
take_action_network
(client, parsed_args)¶Override to do something useful.
update_parser_common
(parser)¶Default is no updates to parser.
update_parser_compute
(parser)¶Default is no updates to parser.
update_parser_network
(parser)¶Default is no updates to parser.
openstackclient.network.common.
NetworkAndComputeCommand
(app, app_args, cmd_name=None)¶Bases: openstackclient.network.common.NetDetectionMixin
, osc_lib.command.command.Command
Network and Compute Command
Command class for commands that support implementation via the network or compute endpoint. Such commands have different implementations for take_action() and may even have different arguments.
log
= <Logger openstackclient.network.common.NetworkAndComputeCommand (WARNING)>¶openstackclient.network.common.
NetworkAndComputeDelete
(app, app_args, cmd_name=None)¶Bases: openstackclient.network.common.NetworkAndComputeCommand
Network and Compute Delete
Delete class for commands that support implementation via the network or compute endpoint. Such commands have different implementations for take_action() and may even have different arguments. This class supports bulk deletion, and error handling following the rules in doc/source/command-errors.rst.
log
= <Logger openstackclient.network.common.NetworkAndComputeDelete (WARNING)>¶take_action
(parsed_args)¶Override to do something useful.
The returned value will be returned by the program.
openstackclient.network.common.
NetworkAndComputeLister
(app, app_args, cmd_name=None)¶Bases: openstackclient.network.common.NetDetectionMixin
, osc_lib.command.command.Lister
Network and Compute Lister
Lister class for commands that support implementation via the network or compute endpoint. Such commands have different implementations for take_action() and may even have different arguments.
log
= <Logger openstackclient.network.common.NetworkAndComputeLister (WARNING)>¶openstackclient.network.common.
NetworkAndComputeShowOne
(app, app_args, cmd_name=None)¶Bases: openstackclient.network.common.NetDetectionMixin
, osc_lib.command.command.ShowOne
Network and Compute ShowOne
ShowOne class for commands that support implementation via the network or compute endpoint. Such commands have different implementations for take_action() and may even have different arguments.
log
= <Logger openstackclient.network.common.NetworkAndComputeShowOne (WARNING)>¶take_action
(parsed_args)¶Return a two-part tuple with a tuple of column names and a tuple of values.
openstackclient.network.common.
check_missing_extension_if_error
(client_manager, attrs)¶openstackclient.network.sdk_utils.
get_osc_show_columns_for_sdk_resource
(sdk_resource, osc_column_map, invisible_columns=None)¶Get and filter the display and attribute columns for an SDK resource.
Common utility function for preparing the output of an OSC show command. Some of the columns may need to get renamed, others made invisible.
sdk_resource – An SDK resource
osc_column_map – A hash of mappings for display column names
invisible_columns – A list of invisible column names
Two tuples containing the names of the display and attribute columns
openstackclient.network.utils.
transform_compute_security_group_rule
(sg_rule)¶Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.