openstackclient.network package¶
Subpackages¶
- openstackclient.network.v2 package
- Submodules
- openstackclient.network.v2.address_scope 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.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.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
Submodules¶
openstackclient.network.client module¶
-
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 module¶
-
class
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)¶
-
property
is_docs_build
¶
-
property
is_neutron
¶
-
property
is_nova_network
¶
-
static
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.
-
-
class
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)>¶
-
-
class
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.
-
-
class
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)>¶
-
-
class
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 module¶
-
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.
- Parameters
sdk_resource – An SDK resource
osc_column_map – A hash of mappings for display column names
invisible_columns – A list of invisible column names
- Returns
Two tuples containing the names of the display and attribute columns
openstackclient.network.utils module¶
-
openstackclient.network.utils.
transform_compute_security_group_rule
(sg_rule)¶