openstackclient.network package

Subpackages

Submodules

openstackclient.network.client module

openstackclient.network.client.build_option_parser(parser: ArgumentParser) → ArgumentParser

Hook to add global options

openstackclient.network.client.make_client(instance: Any) → Any

Returns a network proxy

openstackclient.network.common module

class openstackclient.network.common.NetDetectionMixin(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Command

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: str) → str
enhance_help_nova_network(_help: str) → str
get_parser(prog_name: str) → ArgumentParser

Return an argparse.ArgumentParser.

property is_docs_build: bool
property is_neutron: bool
property is_nova_network: bool
log: logging.Logger = <Logger openstackclient.network.common.NetDetectionMixin (WARNING)>
static split_help(network_help: str, compute_help: str) → str
take_action(parsed_args: Namespace) → Any

Override to do something useful.

The returned value will be returned by the program.

take_action_compute(client: Any, parsed_args: Namespace) → Any

Override to do something useful.

take_action_network(client: Any, parsed_args: Namespace) → Any

Override to do something useful.

update_parser_common(parser: ArgumentParser) → ArgumentParser

Default is no updates to parser.

update_parser_compute(parser: ArgumentParser) → ArgumentParser

Default is no updates to parser.

update_parser_network(parser: ArgumentParser) → ArgumentParser

Default is no updates to parser.

class openstackclient.network.common.NetworkAndComputeCommand(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: NetDetectionMixin, 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: logging.Logger = <Logger openstackclient.network.common.NetworkAndComputeCommand (WARNING)>
class openstackclient.network.common.NetworkAndComputeDelete(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: 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: logging.Logger = <Logger openstackclient.network.common.NetworkAndComputeDelete (WARNING)>
resource: str
take_action(parsed_args: Namespace) → None

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.network.common.NetworkAndComputeLister(app: App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: NetDetectionMixin, 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: logging.Logger = <Logger openstackclient.network.common.NetworkAndComputeLister (WARNING)>
class openstackclient.network.common.NetworkAndComputeShowOne(app: App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: NetDetectionMixin, 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: logging.Logger = <Logger openstackclient.network.common.NetworkAndComputeShowOne (WARNING)>
take_action(parsed_args: Namespace) → Any

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

class openstackclient.network.common.NeutronCommandWithExtraArgs(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Command

Create and Update commands with additional extra properties.

Extra properties can be passed to the command and are then send to the Neutron as given to the command.

get_parser(prog_name: str) → ArgumentParser

Return an argparse.ArgumentParser.

log: logging.Logger = <Logger openstackclient.network.common.NeutronCommandWithExtraArgs (WARNING)>
class openstackclient.network.common.NeutronUnsetCommandWithExtraArgs(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: NeutronCommandWithExtraArgs

log: logging.Logger = <Logger openstackclient.network.common.NeutronUnsetCommandWithExtraArgs (WARNING)>
openstackclient.network.common.check_missing_extension_if_error(client_manager: Any, attrs: dict[str, Any]) → Generator[None, None, None]

openstackclient.network.utils module

openstackclient.network.utils.convert_ipvx_case(string: str) → str
openstackclient.network.utils.convert_to_lowercase(string: str) → str
openstackclient.network.utils.format_network_port_range(rule: dict[str, Any]) → str
openstackclient.network.utils.format_remote_ip_prefix(rule: dict[str, Any]) → str | None
openstackclient.network.utils.format_security_group_rule_show(obj: dict[str, Any]) → tuple[Sequence[str], Iterable[Any]]
openstackclient.network.utils.get_ethertype(parsed_args: Any, protocol: str | None) → str
openstackclient.network.utils.get_protocol(parsed_args: Any, default_protocol: str = 'any') → str | None
openstackclient.network.utils.is_icmp_protocol(protocol: str | None) → bool
openstackclient.network.utils.is_ipv6_protocol(protocol: str | None) → bool
openstackclient.network.utils.str2bool(strbool: str | None) → bool | None
openstackclient.network.utils.str2dict(strdict: str) → dict[str, str]

Convert key1:value1;key2:value2;… string into dictionary.

Parameters:

strdict – string in the form of key1:value1;key2:value2

openstackclient.network.utils.str2list(strlist: str | None) → list[str]
openstackclient.network.utils.transform_compute_security_group_rule(sg_rule: dict[str, Any]) → dict[str, Any]

Module contents