Module ImportFrom alias Assign NameStore Str ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam defaults body Expr Str TryExcept body Return BinOpMod Str TupleLoad AttributeLoad NameLoad attr NameLoad handlers ExceptHandler type NameLoad body Return BinOpMod Str NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults Str NameLoad NameLoad NameLoad body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults Str body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults Str body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults Str body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults Str Str Str body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults ListLoad body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults ListLoad body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Expr Str Raise Call AttributeLoad NameLoad attr NameLoad decorator_list decorator_list
N/A proliantutils exception N/A ERRMSG The specified operation is not supported on current platform. IloOperations N/A object N/A N/A iLO class for performing iLO Operations.

    This class provides an OO interface for retrieving information
    and managing iLO. It implements the same interface in
    python as described in HP iLO 4 Scripting and Command Line Guide.

     _ N/A N/A self msg N/A N/A N/A Prepends host information if available to msg and returns it. N/A N/A N/A N/A [iLO %s] %s N/A N/A self host msg N/A N/A N/A AttributeError N/A N/A N/A [iLO <unknown>] %s msg N/A get_all_licenses N/A N/A self N/A N/A N/A Retrieve license type, key, installation date, etc. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_product_name N/A N/A self N/A N/A N/A Get the model name of the queried server. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_host_power_status N/A N/A self N/A N/A N/A Request the power state of the server. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_http_boot_url N/A N/A self N/A N/A N/A Request the http boot url.

        :returns: URL for http boot.
        :raises: IloError, on an error from iLO.
        :raises: IloCommandNotSupportedError, if the command is not supported
                 on the server.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A set_http_boot_url N/A N/A self url N/A N/A N/A Set the url to the UefiShellStartupUrl.

        :param url: URL for http boot.
        :raises: IloError, on an error from iLO.
        :raises: IloCommandNotSupportedError, if the command is not supported
                 on the server.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A set_iscsi_boot_info N/A N/A self mac target_name lun ip_address port auth_method username password N/A 3260 None None None N/A N/A Set iscsi details of the system in uefi boot mode.

        The iSCSI initiator is identified by the MAC provided.
        The initiator system is set with the target details like
        IQN, LUN, IP, Port etc.
        :param mac: MAC address of initiator.
        :param target_name: Target Name for iscsi.
        :param lun: logical unit number.
        :param ip_address: IP address of the target.
        :param port: port of the target.
        :param auth_method : either None or CHAP.
        :param username: CHAP Username for authentication.
        :param password: CHAP secret.
        :raises: IloError, on an error from iLO.
        :raises: IloCommandNotSupportedInBiosError, if the system is
                 in the bios boot mode.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_one_time_boot N/A N/A self N/A N/A N/A Retrieves the current setting for the one time boot. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_vm_status N/A N/A self device N/A FLOPPY N/A N/A Returns the virtual media drive status like url, is connected, etc.

         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A reset_server N/A N/A self N/A N/A N/A Resets the server. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A press_pwr_btn N/A N/A self N/A N/A N/A Simulates a physical press of the server power button. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A hold_pwr_btn N/A N/A self N/A N/A N/A Simulate a physical press and hold of the server power button. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A set_host_power N/A N/A self power N/A N/A N/A Toggle the power button of server.

        :param power: 'ON' or 'OFF'
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A set_one_time_boot N/A N/A self value N/A N/A N/A Configures a single boot from a specific device. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A insert_virtual_media N/A N/A self url device N/A FLOPPY N/A N/A Notifies iLO of the location of a virtual media diskette image. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A eject_virtual_media N/A N/A self device N/A FLOPPY N/A N/A Ejects the Virtual Media image if one is inserted. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A set_vm_status N/A N/A self device boot_option write_protect N/A FLOPPY BOOT_ONCE YES N/A N/A Sets the Virtual Media drive status and allows the

        boot options for booting from the virtual media.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_current_boot_mode N/A N/A self N/A N/A N/A Retrieves the current boot mode settings. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_pending_boot_mode N/A N/A self N/A N/A N/A Retrieves the pending boot mode settings. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_supported_boot_mode N/A N/A self N/A N/A N/A Retrieves the supported boot mode. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A set_pending_boot_mode N/A N/A self value N/A N/A N/A Sets the boot mode of the system for next boot. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_persistent_boot N/A N/A self N/A N/A N/A Retrieves the boot order of the host. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_persistent_boot_device N/A N/A self N/A N/A N/A Get the current persistent boot device set for the host. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A set_persistent_boot N/A N/A self values N/A N/A N/A N/A Configures to boot from a specific device. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A update_persistent_boot N/A N/A self device_type N/A N/A N/A N/A Updates persistent boot based on the boot mode. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_secure_boot_mode N/A N/A self N/A N/A N/A Get the status if secure boot is enabled or not. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A set_secure_boot_mode N/A N/A self secure_boot_enable N/A N/A N/A Enable/Disable secure boot on the server. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A reset_secure_boot_keys N/A N/A self N/A N/A N/A Reset secure boot keys to manufacturing defaults. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A clear_secure_boot_keys N/A N/A self N/A N/A N/A Reset all keys. N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A reset_ilo_credential N/A N/A self password N/A N/A N/A Resets the iLO password.

        :param password: The password to be set.
        :raises: IloError, if account not found or on an error from iLO.
        :raises: IloCommandNotSupportedError, if the command is not supported
             on the server.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A reset_ilo N/A N/A self N/A N/A N/A Resets the iLO.

        :raises: IloError, on an error from iLO.
        :raises: IloCommandNotSupportedError, if the command is not supported
                 on the server.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A reset_bios_to_default N/A N/A self N/A N/A N/A Resets the BIOS settings to default values.

        :raises: IloError, on an error from iLO.
        :raises: IloCommandNotSupportedError, if the command is not supported
                 on the server.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_host_uuid N/A N/A self N/A N/A N/A Request host UUID of the server.

        :returns: the host UUID of the server
        :raises: IloConnectionError if failed connecting to the iLO.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_host_health_data N/A N/A self data N/A None N/A N/A Request host health data of the server.

        :param: the data to retrieve from the server, defaults to None.
        :returns: the dictionary containing the embedded health data.
        :raises: IloConnectionError if failed connecting to the iLO.
        :raises: IloError, on an error from iLO.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_host_health_present_power_reading N/A N/A self data N/A None N/A N/A Request the power consumption of the server.

        :param: the data to retrieve from the server, defaults to None.
        :returns: the dictionary containing the power readings.
        :raises: IloConnectionError if failed connecting to the iLO.
        :raises: IloError, on an error from iLO.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_host_health_power_supplies N/A N/A self data N/A None N/A N/A Request the health power supply information.

        :param: the data to retrieve from the server, defaults to None.
        :returns: the dictionary containing the power supply information.
        :raises: IloConnectionError if failed connecting to the iLO.
        :raises: IloError, on an error from iLO.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_host_health_fan_sensors N/A N/A self data N/A None N/A N/A Get the health Fan Sensor Report.

        :param: the data to retrieve from the server, defaults to None.
        :returns: the dictionary containing the fan sensor information.
        :raises: IloConnectionError if failed connecting to the iLO.
        :raises: IloError, on an error from iLO.
         N/A get_host_health_temperature_sensors N/A N/A self data N/A None N/A N/A Get the health Temp Sensor report.

        :param: the data to retrieve from the server, defaults to None.
        :returns: the dictionary containing the temperature sensors
            information.
        :raises: IloConnectionError if failed connecting to the iLO.
        :raises: IloError, on an error from iLO.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_host_health_at_a_glance N/A N/A self data N/A None N/A N/A Get the health at a glance Report.

        :param: the data to retrieve from the server, defaults to None.
        :returns: the dictionary containing the health at a glance information.
        :raises: IloConnectionError if failed connecting to the iLO.
        :raises: IloError, on an error from iLO.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_host_power_readings N/A N/A self N/A N/A N/A Retrieves the host power readings.

        :param: the data to retrieve from the server, defaults to None.
        :returns: the dictionary containing the power readings.
        :raises: IloConnectionError if failed connecting to the iLO.
        :raises: IloError, on an error from iLO.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_essential_properties N/A N/A self N/A N/A N/A Get the essential scheduling properties

        :returns: a dictionary containing memory size, disk size,
                  number of cpus, cpu arch, port numbers and
                  mac addresses.
        :raises: IloError, on an error from iLO.
        :raises: IloCommandNotSupportedError, if the command is not supported
                 on the server.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A get_server_capabilities N/A N/A self N/A N/A N/A Get hardware properties which can be used for scheduling

        :return: a dictionary of server capabilities.
        :raises: IloError, on an error from iLO.
        :raises: IloCommandNotSupportedError, if the command is not supported
                 on the server.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A activate_license N/A N/A self key N/A N/A N/A Activates iLO license.

        :param key: iLO license key.
        :raises: IloError, on an error from iLO.
        :raises: IloCommandNotSupportedError, if the command is not supported
                 on the server.
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A update_firmware N/A N/A self firmware_url component_type N/A N/A N/A Updates the given firmware on the server

        :param firmware_url: location of the firmware file
        :param component_type: Type of component to be applied to.
        :raises: InvalidInputError, if the validation of the input fails
        :raises: IloError, on an error from iLO
        :raises: IloConnectionError, if not able to reach iLO.
        :raises: IloCommandNotSupportedError, if the command is
                 not supported on the server
         N/A N/A N/A exception IloCommandNotSupportedError ERRMSG N/A N/A