Skip to content

bmctools.cli.commands.redfish

Redfish command handlers.

setup_redfish_commands

def setup_redfish_commands(parser: argparse.ArgumentParser) -> None

Setup Redfish subcommands.

Args: parser: Redfish subparser

Parameters:

NameTypeDefaultDescription
parserargparse.ArgumentParser

Returns: None

setup_boot_commands

def setup_boot_commands(parser: argparse.ArgumentParser) -> None

Setup boot management subcommands.

Parameters:

NameTypeDefaultDescription
parserargparse.ArgumentParser

Returns: None

setup_firmware_commands

def setup_firmware_commands(parser: argparse.ArgumentParser) -> None

Setup firmware management subcommands.

Parameters:

NameTypeDefaultDescription
parserargparse.ArgumentParser

Returns: None

setup_system_commands

def setup_system_commands(parser: argparse.ArgumentParser) -> None

Setup system management subcommands.

Parameters:

NameTypeDefaultDescription
parserargparse.ArgumentParser

Returns: None

setup_tpm_commands

def setup_tpm_commands(parser: argparse.ArgumentParser) -> None

Setup TPM management subcommands.

Parameters:

NameTypeDefaultDescription
parserargparse.ArgumentParser

Returns: None

setup_bios_commands

def setup_bios_commands(parser: argparse.ArgumentParser) -> None

Setup BIOS settings subcommands.

Parameters:

NameTypeDefaultDescription
parserargparse.ArgumentParser

Returns: None

setup_dell_commands

def setup_dell_commands(parser: argparse.ArgumentParser) -> None

Setup Dell-specific subcommands.

Parameters:

NameTypeDefaultDescription
parserargparse.ArgumentParser

Returns: None

handle_boot_get_order

def handle_boot_get_order(args: argparse.Namespace) -> dict

Handle ‘redfish boot get-order’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_boot_set_order

def handle_boot_set_order(args: argparse.Namespace) -> dict

Handle ‘redfish boot set-order’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_boot_list_options

def handle_boot_list_options(args: argparse.Namespace) -> dict

Handle ‘redfish boot list-options’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_boot_find_by_mac

def handle_boot_find_by_mac(args: argparse.Namespace) -> dict

Handle ‘redfish boot find-by-mac’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_boot_find_by_alias

def handle_boot_find_by_alias(args: argparse.Namespace) -> dict

Handle ‘redfish boot find-by-alias’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_boot_get_pending

def handle_boot_get_pending(args: argparse.Namespace) -> dict

Handle ‘redfish boot get-pending’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_boot_get_override

def handle_boot_get_override(args: argparse.Namespace) -> dict

Handle ‘redfish boot get-override’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_boot_set_override

def handle_boot_set_override(args: argparse.Namespace) -> dict

Handle ‘redfish boot set-override’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_bios_get

def handle_bios_get(args: argparse.Namespace) -> dict

Handle ‘redfish bios get’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_bios_get_boot

def handle_bios_get_boot(args: argparse.Namespace) -> dict

Handle ‘redfish bios get-boot’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_bios_set

def handle_bios_set(args: argparse.Namespace) -> dict

Handle ‘redfish bios set’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_firmware_inventory

def handle_firmware_inventory(args: argparse.Namespace) -> dict

Handle ‘redfish firmware inventory’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_firmware_status

def handle_firmware_status(args: argparse.Namespace) -> dict

Handle ‘redfish firmware status’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_firmware_update_bios

def handle_firmware_update_bios(args: argparse.Namespace) -> dict

Handle ‘redfish firmware update-bios’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_firmware_update_bmc

def handle_firmware_update_bmc(args: argparse.Namespace) -> dict

Handle ‘redfish firmware update-bmc’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_system_reset

def handle_system_reset(args: argparse.Namespace) -> dict

Handle ‘redfish system reset’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_system_reset_types

def handle_system_reset_types(args: argparse.Namespace) -> dict

Handle ‘redfish system reset-types’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_system_info

def handle_system_info(args: argparse.Namespace) -> dict

Handle ‘redfish system info’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_tpm_set_state

def handle_tpm_set_state(args: argparse.Namespace) -> dict

Handle ‘redfish tpm set-state’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_raw

def handle_raw(args: argparse.Namespace) -> dict

Handle ‘redfish raw’ command — raw GET against any Redfish URI.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_dell_get_boot_options

def handle_dell_get_boot_options(args: argparse.Namespace) -> dict

Handle ‘redfish dell get-boot-options’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_get_nics

def handle_get_nics(args: argparse.Namespace) -> dict

Handle ‘get_nics’ command (manufacturer-agnostic).

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_dell_get_nic_attrs

def handle_dell_get_nic_attrs(args: argparse.Namespace) -> dict

Handle ‘redfish dell get-nic-attrs’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_dell_boot_first_by_mac

def handle_dell_boot_first_by_mac(args: argparse.Namespace) -> dict

Handle ‘redfish dell boot-first-by-mac’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_dell_setup_pxe_boot

def handle_dell_setup_pxe_boot(args: argparse.Namespace) -> dict

Handle ‘redfish dell setup-pxe-boot’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_dell_enable_pxe

def handle_dell_enable_pxe(args: argparse.Namespace) -> dict

Handle ‘redfish dell enable-pxe’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_dell_check_pxe

def handle_dell_check_pxe(args: argparse.Namespace) -> dict

Handle ‘redfish dell check-pxe’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_dell_onetime_boot

def handle_dell_onetime_boot(args: argparse.Namespace) -> dict

Handle ‘redfish dell onetime-boot’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_dell_create_role

def handle_dell_create_role(args: argparse.Namespace) -> dict

Handle ‘redfish dell create-role’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

handle_dell_local_access

def handle_dell_local_access(args: argparse.Namespace) -> dict

Handle ‘redfish dell local-access’ command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: dict

dispatch

def dispatch(args: argparse.Namespace) -> int

Dispatch Redfish command to appropriate handler.

Args: args: Parsed arguments

Returns: Exit code

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: int

dispatch_boot

def dispatch_boot(args: argparse.Namespace) -> int

Dispatch boot command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: int

dispatch_firmware

def dispatch_firmware(args: argparse.Namespace) -> int

Dispatch firmware command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: int

dispatch_system

def dispatch_system(args: argparse.Namespace) -> int

Dispatch system command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: int

dispatch_tpm

def dispatch_tpm(args: argparse.Namespace) -> int

Dispatch TPM command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: int

dispatch_bios

def dispatch_bios(args: argparse.Namespace) -> int

Dispatch BIOS settings command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: int

dispatch_dell

def dispatch_dell(args: argparse.Namespace) -> int

Dispatch Dell-specific command.

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace

Returns: int

handle_alias

def handle_alias(args: argparse.Namespace, target: str) -> int

Handle aliased commands.

Args: args: Parsed arguments target: Alias target identifier

Returns: Exit code

Parameters:

NameTypeDefaultDescription
argsargparse.Namespace
targetstr

Returns: int