ironic.common.kernel_parameters module

class ironic.common.kernel_parameters.KernelCommandLine(parameters, init_args)

Bases: object

Represents a kernel command line.

NOTE: An instantiated object of this type does not guarantee that it has passed parsing via KernelParameterParser. ParsedKernelCommandLine is reserved for this distinction.

as_parameter_set()

asdict()

init_args

parameters

classmethod parse(command_line)

class ironic.common.kernel_parameters.KernelParameter(key: ironic.common.kernel_parameters.ParameterKey, value: ironic.common.kernel_parameters.ParameterValue)

Bases: object

key

value

class ironic.common.kernel_parameters.KernelParameterTransformer(visit_tokens=True)

Bases: Transformer

bare_value(items)

init_arguments(items)

init_suffix(items)

kernel_command_line(items)

key(items)

key_value_pair(items)

parameter(items)

parameter_list(items)

quoted_value(items)

value(items)

value_with_spaces(items)

class ironic.common.kernel_parameters.ParameterKey(key: str)

Bases: object

key

class ironic.common.kernel_parameters.ParameterSet(parameters: dict[str, ironic.common.kernel_parameters.KernelParameter])

Bases: object

asdict()

parameters

class ironic.common.kernel_parameters.ParameterValue(value: str)

Bases: object

value

class ironic.common.kernel_parameters.ParsedKernelCommandLine(parameters, init_args)

Bases: KernelCommandLine

Represents a parsed kernel command line.

NOTE: This object should only be instantiated via passing a kernel command line string through KernelParameterParser.parse() and then the resultant parse tree through KernelParameterTransformer.transform(). Constructing this directly is almost certainly a mistake.

This class helps distinguish between kernel command lines that have been validated by parsing and those that have not.

class ironic.common.kernel_parameters.UnsafeKernelCommandLine(parameters, init_args, unstructured_params)

Bases: KernelCommandLine

Represents a kernel command line that has not been parsed.

Includes the field ‘unstructured_params’, which are treated as opaque strings which haven’t been parsed. To convert this to a ParsedKernelCommandLine, use KernelCommandLine.parse(str(unsafe_cmd_line)).

unstructured_params

class ironic.common.kernel_parameters.UnstructuredParameters(value: str)

Bases: object

value

ironic.common.kernel_parameters.sanitize_kernel_command_line(command_line)

Applies filtering to a command line to sanitize it.

NOTE: This does not guarantee a correct or safe kernel command line, for stronger guarantees of correctness and safety use KernelCommandLine.parse().

Parameters:

command_line – A string containing a kernel command line or individual parameters.

Returns:

A filtered string which should be safer for use.