ironic.api.controllers.v1 package

Submodules

• ironic.api.controllers.v1.allocation module
  • AllocationsController
    • AllocationsController.delete()
    • AllocationsController.get_all()
    • AllocationsController.get_one()
    • AllocationsController.invalid_sort_key_list
    • AllocationsController.patch()
    • AllocationsController.post()
  • NodeAllocationController
    • NodeAllocationController.delete()
    • NodeAllocationController.get_all()
    • NodeAllocationController.invalid_sort_key_list
  • allocation_sanitize()
  • convert_with_links()
  • hide_fields_in_newer_versions()
  • list_convert_with_links()
• ironic.api.controllers.v1.bios module
  • NodeBiosController
    • NodeBiosController.get_all()
    • NodeBiosController.get_one()
  • collection_from_list()
  • convert_with_links()
• ironic.api.controllers.v1.chassis module
  • ChassisController
    • ChassisController.delete()
    • ChassisController.detail()
    • ChassisController.get_all()
    • ChassisController.get_one()
    • ChassisController.invalid_sort_key_list
    • ChassisController.nodes
    • ChassisController.patch()
    • ChassisController.post()
  • convert_with_links()
  • list_convert_with_links()
• ironic.api.controllers.v1.collection module
  • get_next()
  • has_next()
  • list_convert_with_links()
• ironic.api.controllers.v1.conductor module
  • ConductorsController
    • ConductorsController.get_all()
    • ConductorsController.get_one()
    • ConductorsController.invalid_sort_key_list
  • convert_with_links()
  • list_convert_with_links()
• ironic.api.controllers.v1.deploy_template module
  • DeployTemplatesController
    • DeployTemplatesController.delete()
    • DeployTemplatesController.get_all()
    • DeployTemplatesController.get_one()
    • DeployTemplatesController.invalid_sort_key_list
    • DeployTemplatesController.patch()
    • DeployTemplatesController.post()
  • convert_with_links()
  • list_convert_with_links()
  • step_sanitize()
  • template_sanitize()
• ironic.api.controllers.v1.driver module
  • DriverPassthruController
    • DriverPassthruController.methods()
  • DriverRaidController
    • DriverRaidController.logical_disk_properties()
  • DriversController
    • DriversController.get_all()
    • DriversController.get_one()
    • DriversController.properties()
    • DriversController.raid
    • DriversController.vendor_passthru
  • convert_with_links()
  • driver_sanitize()
  • hide_fields_in_newer_versions()
  • list_convert_with_links()
• ironic.api.controllers.v1.event module
  • EventsController
    • EventsController.post()
  • events_valid()
• ironic.api.controllers.v1.firmware module
  • NodeFirmwareController
    • NodeFirmwareController.get_all()
  • collection_from_list()
  • convert_with_links()
• ironic.api.controllers.v1.inspection_rule module
  • InspectionRuleController
    • InspectionRuleController.delete()
    • InspectionRuleController.get_all()
    • InspectionRuleController.get_one()
    • InspectionRuleController.invalid_sort_key_list
    • InspectionRuleController.patch()
    • InspectionRuleController.post()
  • convert_actions()
  • convert_conditions()
  • convert_with_links()
  • list_convert_with_links()
  • rules_sanitize()
• ironic.api.controllers.v1.node module
  • BootDeviceController
    • BootDeviceController.get()
    • BootDeviceController.put()
    • BootDeviceController.supported()
  • GetNodeAndTopicMixin
  • IndicatorAtComponent
  • IndicatorController
    • IndicatorController.get_all()
    • IndicatorController.get_one()
    • IndicatorController.put()
  • InjectNmiController
    • InjectNmiController.put()
  • NodeChildrenController
    • NodeChildrenController.get_all()
  • NodeConsoleController
    • NodeConsoleController.get()
    • NodeConsoleController.put()
  • NodeHistoryController
    • NodeHistoryController.detail_fields
    • NodeHistoryController.get_all()
    • NodeHistoryController.get_one()
    • NodeHistoryController.standard_fields
  • NodeInventoryController
    • NodeInventoryController.get()
  • NodeMaintenanceController
    • NodeMaintenanceController.delete()
    • NodeMaintenanceController.put()
  • NodeManagementController
    • NodeManagementController.boot_device
    • NodeManagementController.indicators
    • NodeManagementController.inject_nmi
  • NodeStatesController
    • NodeStatesController.boot_mode()
    • NodeStatesController.console
    • NodeStatesController.get()
    • NodeStatesController.power()
    • NodeStatesController.provision()
    • NodeStatesController.raid()
    • NodeStatesController.secure_boot()
  • NodeTraitsController
    • NodeTraitsController.delete()
    • NodeTraitsController.get_all()
    • NodeTraitsController.put()
  • NodeVIFController
    • NodeVIFController.delete()
    • NodeVIFController.get_all()
    • NodeVIFController.post()
  • NodeVendorPassthruController
    • NodeVendorPassthruController.methods()
  • NodeVmediaController
    • NodeVmediaController.delete()
    • NodeVmediaController.get()
    • NodeVmediaController.post()
  • NodesController
    • NodesController.delete()
    • NodesController.detail()
    • NodesController.from_chassis
    • NodesController.get_all()
    • NodesController.get_one()
    • NodesController.invalid_sort_key_list
    • NodesController.maintenance
    • NodesController.management
    • NodesController.parent_node
    • NodesController.patch()
    • NodesController.post()
    • NodesController.states
    • NodesController.validate()
    • NodesController.vendor_passthru
  • get_nodes_controller_reserved_names()
  • hide_fields_in_newer_versions()
  • indicator_convert_with_links()
  • indicator_list_from_dict()
  • network_data_schema()
  • node_convert_with_links()
  • node_list_convert_with_links()
  • node_patch_schema()
  • node_patch_validator()
  • node_sanitize()
  • node_schema()
  • node_states_convert()
  • node_validator()
  • reject_fields_in_newer_versions()
  • reject_patch_in_newer_versions()
  • update_state_in_older_versions()
  • validate_network_data()
• ironic.api.controllers.v1.notification_utils module
  • emit_end_notification()
  • emit_start_notification()
  • handle_error_notification()
• ironic.api.controllers.v1.port module
  • PortsController
    • PortsController.advanced_net_fields
    • PortsController.delete()
    • PortsController.detail()
    • PortsController.get_all()
    • PortsController.get_one()
    • PortsController.invalid_sort_key_list
    • PortsController.patch()
    • PortsController.post()
  • convert_with_links()
  • hide_fields_in_newer_versions()
  • list_convert_with_links()
  • port_sanitize()
• ironic.api.controllers.v1.portgroup module
  • PortgroupsController
    • PortgroupsController.delete()
    • PortgroupsController.detail()
    • PortgroupsController.get_all()
    • PortgroupsController.get_one()
    • PortgroupsController.invalid_sort_key_list
    • PortgroupsController.patch()
    • PortgroupsController.post()
  • convert_with_links()
  • hide_fields_in_newer_versions()
  • list_convert_with_links()
  • portgroup_sanitize()
• ironic.api.controllers.v1.ramdisk module
  • ContinueInspectionController
    • ContinueInspectionController.post()
  • HeartbeatController
    • HeartbeatController.post()
  • LookupController
    • LookupController.get_all()
    • LookupController.lookup_allowed()
  • config()
  • convert_with_links()
  • get_valid_mac_addresses()
• ironic.api.controllers.v1.runbook module
  • RunbooksController
    • RunbooksController.delete()
    • RunbooksController.get_all()
    • RunbooksController.get_one()
    • RunbooksController.invalid_sort_key_list
    • RunbooksController.patch()
    • RunbooksController.post()
  • convert_with_links()
  • list_convert_with_links()
  • runbook_sanitize()
  • step_sanitize()
• ironic.api.controllers.v1.shard module
  • ShardController
    • ShardController.get_all()
    • ShardController.get_one()
• ironic.api.controllers.v1.utils module
  • PassthruResponse
    • PassthruResponse.obj
    • PassthruResponse.status_code
  • allow_agent_token()
  • allow_agent_version_in_heartbeat()
  • allow_allocation_backfill()
  • allow_allocation_owner()
  • allow_allocations()
  • allow_attach_detach_vmedia()
  • allow_bios_interface()
  • allow_build_configdrive()
  • allow_configdrive_vendor_data()
  • allow_continue_inspection_endpoint()
  • allow_deploy_steps()
  • allow_deploy_templates()
  • allow_detail_query()
  • allow_dynamic_drivers()
  • allow_dynamic_interfaces()
  • allow_expose_conductors()
  • allow_expose_events()
  • allow_field()
  • allow_firmware_interface()
  • allow_get_vmedia()
  • allow_inject_nmi()
  • allow_inspect_abort()
  • allow_inspect_wait_state()
  • allow_inspection_rules()
  • allow_links_node_states_and_driver_properties()
  • allow_local_link_connection_network_type()
  • allow_node_history()
  • allow_node_ident_as_param_for_port_creation()
  • allow_node_inventory()
  • allow_node_logical_names()
  • allow_node_rebuild_with_configdrive()
  • allow_ovn_vtep_version()
  • allow_port_advanced_net_fields()
  • allow_port_category()
  • allow_port_description()
  • allow_port_internal_info()
  • allow_port_is_smartnic()
  • allow_port_name()
  • allow_port_physical_network()
  • allow_port_vendor()
  • allow_portgroup_mode_properties()
  • allow_portgroup_physical_network()
  • allow_portgroups()
  • allow_portgroups_subcontrollers()
  • allow_query_bios()
  • allow_raid_config()
  • allow_ramdisk_endpoints()
  • allow_remove_chassis_uuid()
  • allow_rescue_interface()
  • allow_reset_interfaces()
  • allow_runbooks()
  • allow_service_verb()
  • allow_shards_endpoint()
  • allow_soft_power_off()
  • allow_special_characters_in_patch_fields()
  • allow_status_in_heartbeat()
  • allow_storage_interface()
  • allow_traits()
  • allow_unhold_verb()
  • allow_verify_ca_in_heartbeat()
  • allow_vifs_subcontroller()
  • allow_volume()
  • apply_jsonpatch()
  • check_allocation_policy_and_retrieve()
  • check_allow_boot_mode()
  • check_allow_child_node_params()
  • check_allow_clean_disable_ramdisk()
  • check_allow_configdrive()
  • check_allow_deploy_steps()
  • check_allow_driver_detail()
  • check_allow_filter_by_conductor()
  • check_allow_filter_by_conductor_group()
  • check_allow_filter_by_fault()
  • check_allow_filter_by_lessee()
  • check_allow_filter_by_owner()
  • check_allow_filter_by_shard()
  • check_allow_filter_driver_type()
  • check_allow_management_verbs()
  • check_allow_specify_driver()
  • check_allow_specify_fields()
  • check_allow_specify_resource_class()
  • check_allowed_fields()
  • check_allowed_portgroup_fields()
  • check_and_retrieve_public_runbook()
  • check_for_invalid_fields()
  • check_for_invalid_state_and_allow_filter()
  • check_list_policy()
  • check_multiple_node_policies_and_retrieve()
  • check_multiple_runbook_policies_and_retrieve()
  • check_node_policy_and_retrieve()
  • check_owner_policy()
  • check_policy()
  • check_policy_true()
  • check_port_list_policy()
  • check_port_policy_and_retrieve()
  • check_runbook_policy_and_retrieve()
  • check_volume_list_policy()
  • check_volume_policy_and_retrieve()
  • convert_steps()
  • decode_json_pointer()
  • disallowed_fields()
  • duplicate_steps()
  • get_controller_reserved_names()
  • get_patch_values()
  • get_request_return_fields()
  • get_rpc_allocation()
  • get_rpc_allocation_with_suffix()
  • get_rpc_deploy_template()
  • get_rpc_deploy_template_with_suffix()
  • get_rpc_node()
  • get_rpc_node_with_suffix()
  • get_rpc_portgroup()
  • get_rpc_portgroup_with_suffix()
  • get_rpc_runbook()
  • initial_node_provision_state()
  • is_path_removed()
  • is_path_updated()
  • is_valid_logical_name()
  • is_valid_node_name()
  • local_link_normalize()
  • new_continue_inspection_endpoint()
  • object_to_dict()
  • patch_update_changed_fields()
  • patch_validate_allowed_fields()
  • patched_validate_with_schema()
  • populate_node_uuid()
  • replace_node_id_with_uuid()
  • replace_node_uuid_with_id()
  • sanitize_dict()
  • validate_limit()
  • validate_sort_dir()
  • vendor_passthru()
• ironic.api.controllers.v1.versions module
  • max_version_string()
  • min_version_string()
• ironic.api.controllers.v1.volume module
  • VolumeController
    • VolumeController.get()
  • convert()
• ironic.api.controllers.v1.volume_connector module
  • VolumeConnectorsController
    • VolumeConnectorsController.delete()
    • VolumeConnectorsController.get_all()
    • VolumeConnectorsController.get_one()
    • VolumeConnectorsController.invalid_sort_key_list
    • VolumeConnectorsController.patch()
    • VolumeConnectorsController.post()
  • convert_with_links()
  • list_convert_with_links()
• ironic.api.controllers.v1.volume_target module
  • VolumeTargetsController
    • VolumeTargetsController.delete()
    • VolumeTargetsController.get_all()
    • VolumeTargetsController.get_one()
    • VolumeTargetsController.invalid_sort_key_list
    • VolumeTargetsController.patch()
    • VolumeTargetsController.post()
  • convert_with_links()
  • list_convert_with_links()

Module contents

Version 1 of the Ironic API

Specification can be found at doc/source/webapi/v1.rst

class ironic.api.controllers.v1.Controller

Bases: object

Version 1 API controller root.

add_version_attributes()

index()