Skip navigation links
io.swagger.client.api

Class RedfishApi

    • Constructor Detail

      • RedfishApi

        public RedfishApi()
        Redfish Client API default constructors
      • RedfishApi

        public RedfishApi(ApiClient apiClient)
        Redfish Client API constructors with ApiClient argument
    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
        get ApiClient
      • setApiClient

        public void setApiClient(ApiClient apiClient)
        set ApiClient
      • setQuertParams

        public void setQuertParams(List<QueryPair> queryParams)
        set request query parameters
      • setHeaderParams

        public void setHeaderParams(Map<String,String> headerParams)
        set request header parameters
      • setFormParams

        public void setFormParams(Map<String,Object> formParams)
        set request form parameters
      • getServiceRoot

        public ServiceRoot100ServiceRoot getServiceRoot()
                                                 throws ApiException
        • Web Target URI : /redfish/v1
        Retrieve list of root-level resources This object represents the root Redfish service. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification.
        Returns:
        ServiceRoot100ServiceRoot
        Throws:
        ApiException
      • getServiceRootDocument

        public ServiceRootDocument getServiceRootDocument()
                                                   throws ApiException
        • Web Target URI : /redfish/v1/odata
        Retrieve list of root-level resources This object represents the root Redfish service. All values for resources described by this odata shall comply to the requirements as described in the Redfish services.
        Returns:
        ServiceRootDocument
        Throws:
        ApiException
      • doManagerReset

        public void doManagerReset(Manager100Reset postBody,
                                   String identifier)
                            throws ApiException
        • POST Target URI : /Managers/{identifier}/Actions/Manager.Reset
        POST action of Manager Reset to management server.
        Parameters:
        postBody - : post object of manager reset action by Manager100Reset
        identifier - : input management identifier
        Throws:
        ApiException
      • getAccountService

        public AccountService100AccountService getAccountService(String identifier)
                                                          throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/AccountService
        Retrieve account service information in management server.
        Parameters:
        identifier - : input management identifier
        Returns:
        AccountService100AccountService
        Throws:
        ApiException
      • getAccount

        public ManagerAccount100ManagerAccount getAccount(String identifier,
                                                          int IDnumber)
                                                   throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/Accounts/{IDnumber}
        Retrieve information about the specified account by given ID number
        Parameters:
        identifier - : input management identifier
        IDnumber - : account ID number
        Returns:
        ManagerAccount100ManagerAccount
        Throws:
        ApiException
      • getRoleCollection

        public RoleCollectionRoleCollection getRoleCollection(String identifier)
                                                       throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/Roles
        Retrieve list of roles
        Parameters:
        identifier - : input management identifier
        Returns:
        RoleCollectionRoleCollection
        Throws:
        ApiException
      • getRole

        public Role100Role getRole(String identifier,
                                   String Role)
                            throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/Roles/{Role}
        Retrieve privileges for a role (Administrator, Operator, ...etc)
        Parameters:
        identifier - : input management identifier
        Role - : privileges
        Returns:
        Role100Role
        Throws:
        ApiException
      • getLogServiceCollection

        public LogServiceCollectionLogServiceCollection getLogServiceCollection(String identifier)
                                                                         throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/LogServices
        Retrieve Logs services for a computer system in Managers Defines a collection of log services that are available for the system described by identifier
        Parameters:
        identifier - : input management identifier
        Returns:
        LogServiceCollectionLogServiceCollection
        Throws:
        ApiException
      • getSelLogService

        public LogService100LogService getSelLogService(String identifier)
                                                 throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/LogServices/Sel
        Retrieve Sel Log Service for a computer system in Managers Defines a LogService of SEL entries for the system described by identifier.
        Parameters:
        identifier - : input management identifier
        Returns:
        LogService100LogService
        Throws:
        ApiException
      • doClearLog

        public void doClearLog(String identifier)
                        throws ApiException
        • POST Target URI : /Managers/{identifier}/LogServices/Sel/Actions/LogService.ClearLog
        POST action of LogService Clear Log on management server.
        Parameters:
        identifier - : input management identifier
        Throws:
        ApiException
      • getLcLogService

        public LogService100LogService getLcLogService(String identifier)
                                                throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/LogServices/Lclog
        Retrieve LifeCycle Controller Log Service for a computer system in Managers Defines a LogService of SEL LifeCycle Controller Log for the system described by identifier.
        Parameters:
        identifier - : input management identifier
        Returns:
        LogService100LogService
        Throws:
        ApiException
      • getSelLogEntryCollection

        public LogEntryCollectionLogEntryCollection getSelLogEntryCollection(String identifier)
                                                                      throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/Logs/Sel
        Retrieve Sel log Entry collection of the Sel logs entries for associated for Sel log service Defines a collection of Sel entries for the system described by identifier
        Parameters:
        identifier - : input management identifier
        Returns:
        LogEntryCollectionLogEntryCollection
        Throws:
        ApiException
      • getLcLogEntryCollection

        public LogEntryCollectionLogEntryCollection getLcLogEntryCollection(String identifier)
                                                                     throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/Logs/Lclog
        Retrieve LifeCycle Controller Log Entry collection of the LifeCycle Controller Log entries for associated for Sel log service Defines a collection of LifeCycle Controller Log entries for the system described by identifier
        Parameters:
        identifier - : input management identifier
        Returns:
        LogEntryCollectionLogEntryCollection
        Throws:
        ApiException
      • getSelLogEntry

        public LogEntry100LogEntry getSelLogEntry(String identifier,
                                                  String entryId)
                                           throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/Logs/Sel/{entryId}
        Retrieve log entry by logId associated for log service Defines a log entry specified by entryId within the LogService of the specified type for the system described by identifier
        Parameters:
        identifier - : input management identifier
        entryId - : Sel entry Id
        Returns:
        LogEntry100LogEntry
        Throws:
        ApiException
      • getLcLogEntry

        public LogEntry100LogEntry getLcLogEntry(String identifier,
                                                 String entryId)
                                          throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/Logs/Lclog/{entryId}
        Retrieve LifeCycle Controller Log by logId associated for log service Defines a LifeCycle Controller Log entry specified by entryId within the LogService of the specified type for the system described by identifier
        Parameters:
        identifier - : input management identifier
        entryId - : LifeCycle Controller Log entry Id
        Returns:
        LogEntry100LogEntry
        Throws:
        ApiException
      • getManagerEthernetInterfaces

        public EthernetInterfaceCollectionEthernetInterfaceCollection getManagerEthernetInterfaces(String identifier)
                                                                                            throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/EthernetInterfaces
        Retrieve list about the management ethernet interfaces
        Parameters:
        identifier - : input management identifier
        Returns:
        EthernetInterfaceCollectionEthernetInterfaceCollection
        Throws:
        ApiException
      • getManagerEthernetInterface

        public EthernetInterface100EthernetInterface getManagerEthernetInterface(String identifier,
                                                                                 String index)
                                                                          throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/EthernetInterfaces/{index}
        Retrieve information about the specified ethernet interface
        Parameters:
        identifier - : input management identifier
        index - : management Ethernet NIC
        Returns:
        EthernetInterface100EthernetInterface
        Throws:
        ApiException
      • getNetworkProtocol

        public ManagerNetworkProtocol100ManagerNetworkProtocol getNetworkProtocol(String identifier)
                                                                           throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/NetworkProtocol
        Retrieve list about the Manager NetworkProtocol
        Parameters:
        identifier - : input management identifier
        Returns:
        ManagerNetworkProtocol100ManagerNetworkProtocol
        Throws:
        ApiException
      • getSerialInterfaceCollection

        public SerialInterfaceCollectionSerialInterfaceCollection getSerialInterfaceCollection(String identifier)
                                                                                        throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/SerialInterfaces
        Retrieve list about the serial interface
        Parameters:
        identifier - : input management identifier
        Returns:
        SerialInterfaceCollectionSerialInterfaceCollection
        Throws:
        ApiException
      • getSerialInterface

        public SerialInterface100SerialInterface getSerialInterface(String identifier,
                                                                    String index)
                                                             throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/SerialInterfaces/{index}
        Retrieve information about the serial interface
        Parameters:
        identifier - : input management identifier
        index - : management serial interface
        Returns:
        SerialInterface100SerialInterface
        Throws:
        ApiException
      • getVitualMediaCollection

        public VirtualMediaCollectionVirtualMediaCollection getVitualMediaCollection(String identifier)
                                                                              throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/VirtualMedia
        Retrieve list about the virtual media
        Parameters:
        identifier - : input management identifier
        Returns:
        VirtualMediaCollectionVirtualMediaCollection
        Throws:
        ApiException
      • getVitualMedia

        public VirtualMedia100VirtualMedia getVitualMedia(String identifier,
                                                          String index)
                                                   throws ApiException
        • Web Target URI : /redfish/v1/Managers/{identifier}/VirtualMedia/{index}
        Retrieve information about the virtual media
        Parameters:
        identifier - : input management identifier
        index - : management virtual media devices
        Returns:
        VirtualMedia100VirtualMedia
        Throws:
        ApiException
      • getChassisCollection

        public ChassisCollectionChassisCollection getChassisCollection()
                                                                throws ApiException
        • Web Target URI : /redfish/v1/Chassis
        Retrieve list of physical components Defines a collection of physical components managed by the service
        Returns:
        ChassisCollectionChassisCollection
        Throws:
        ApiException
      • getChassis

        public Chassis100Chassis getChassis(String identifier)
                                     throws ApiException
        • Web Target URI : /redfish/v1/Chassis/{identifier}
        Retrieve specific information for a physical component Retrieves a detailed information catalog for the physical component specified by identifier
        Parameters:
        identifier - : input system identifier
        Returns:
        Chassis100Chassis
        Throws:
        ApiException
      • doChassisReset

        public void doChassisReset(Chassis100Reset postBody,
                                   String identifier)
                            throws ApiException
        • POST Target URI : /Chassis/{identifier}/Actions/Chassis.Reset
        POST action of Chassis Reset to management server.
        Parameters:
        postBody - : post object of chassis reset action by Manager100Reset
        identifier - : input system identifier
        Throws:
        ApiException
      • getPower

        public Power100Power getPower(String identifier)
                               throws ApiException
        • Web Target URI : /redfish/v1/Chassis/{identifier}/Power
        Retrieve power characteristics of a chassis defines a collection of power elements contained within a resource.
        Parameters:
        identifier - : input system identifier
        Returns:
        Power100Power
        Throws:
        ApiException
      • getPowerControl

        public Power100PowerControl getPowerControl(String identifier)
                                             throws ApiException
        • Web Target URI : /redfish/v1/Chassis/{identifier}/Power/PowerControl
        Retrieve power Control characteristics of a chassis defines a collection of power elements contained within a resource.
        Parameters:
        identifier - : input system identifier
        Returns:
        Power100PowerControl
        Throws:
        ApiException
      • getPowerSupplyList

        public List<Power100PowerSupply> getPowerSupplyList(String identifier)
                                                     throws ApiException
        • Web Target URI : /redfish/v1/Chassis/{identifier}/Power
        Retrieve power supply list characteristics of a chassis defines a collection of power elements contained within a resource.
        Parameters:
        identifier - : input system identifier
        Returns:
        List < Power100PowerSupply >
        Throws:
        ApiException
      • getPowerSupply

        public Power100PowerSupply getPowerSupply(String identifier,
                                                  String PSUid)
                                           throws ApiException
        • Web Target URI : /redfish/v1/Chassis/{identifier}/Power/PowerSupplies/{PSUid}
        Retrieve power supply characteristics of a chassis defines a collection of power elements contained within a resource.
        Parameters:
        identifier - : input system identifier
        Returns:
        Power100PowerSupply
        Throws:
        ApiException
      • getVoltageSensorList

        public List<Power100Voltage> getVoltageSensorList(String identifier)
                                                   throws ApiException
        • Web Target URI : /redfish/v1/Chassis/{identifier}/Power
        Retrieve power voltage sensor list characteristics of a chassis defines a collection of power elements contained within a resource.
        Parameters:
        identifier - : input system identifier
        Returns:
        Power100Power
        Throws:
        ApiException
      • getThermal

        public Thermal100Thermal getThermal(String identifier)
                                     throws ApiException
        • Web Target URI : /redfish/v1/Chassis/{identifier}/Thermal
        Retrieve thermal characteristics of a chassis defines a collection of thermal elements contained within a resource.
        Parameters:
        identifier - : input system identifier
        Returns:
        Thermal100Thermal
        Throws:
        ApiException
      • getFanSensorList

        public List<Thermal100Fan> getFanSensorList(String identifier)
                                             throws ApiException
        • Web Target URI : /redfish/v1/Chassis/{identifier}/Thermal
        Retrieve thermal Fans Sensor List of a chassis defines a collection of thermal elements contained within a resource.
        Parameters:
        identifier - : input system identifier
        Returns:
        List < Thermal100Temperature >
        Throws:
        ApiException
      • getFanSensor

        public Thermal100Fan getFanSensor(String identifier,
                                          String fanId)
                                   throws ApiException
        • Web Target URI : /redfish/v1/Chassis/{identifier}/Sensors/Fans/{fanId}
        Retrieve thermal Fans Sensor of a chassis defines a collection of thermal elements contained within a resource.
        Parameters:
        identifier - : input system identifier
        fanId - : Fan Sensor identifier
        Returns:
        Thermal100Temperature
        Throws:
        ApiException
      • getTemperatureSensorList

        public List<Thermal100Temperature> getTemperatureSensorList(String identifier)
                                                             throws ApiException
        • Web Target URI : /redfish/v1/Chassis/{identifier}/Thermal
        Retrieve thermal Temperature Sensor List of a chassis defines a collection of thermal elements contained within a resource.
        Parameters:
        identifier - : input system identifier
        Returns:
        List < Thermal100Temperature >
        Throws:
        ApiException
      • getSystem

        public ComputerSystem100ComputerSystem getSystem(String identifier)
                                                  throws ApiException
        • Web Target URI : /redfish/v1/Systems/{identifier}
        Retrieve information for a specific computer systems (physical and/or virtual) defines a computer system and its respective properties. A computer system represents a machine (physical or virtual) and the local resources such as memory, cpu and other devices that can be accessed from that machine.
        Parameters:
        identifier - : node system identifier
        Returns:
        ComputerSystem100ComputerSystem
        Throws:
        ApiException
      • doComputerSystemReset

        public void doComputerSystemReset(ComputerSystem100Reset payload,
                                          String identifier)
                                   throws ApiException
        • POST Target URI : /redfish/v1/Systems/{identifier}/Actions/ComputerSystem.Reset
        Action of computer system reset a node . Perform the reset specified in the post data arguments on the system described by identifier
        Parameters:
        identifier - : node system identifier
        payload - : POST reset type payload
        Throws:
        ApiException
      • getBootMenu

        public ComputerSystem100Boot getBootMenu(String identifier)
                                          throws ApiException
        • Web Target URI : /redfish/v1/Systems/{identifier}
        Retrieve the list of boot image types for the specified compute node Retrieve a list of valid boot image types for the system described by identifier
        Parameters:
        identifier - : node system identifier
        Returns:
        ComputerSystem100Boot
        Throws:
        ApiException
      • postBootOverrideSetting

        public void postBootOverrideSetting(ComputerSystem100Boot payload,
                                            String identifier)
                                     throws ApiException
        • Web Target URI : /redfish/v1/Systems/{identifier}
        Setting the boot override parameters Perform the boot specified in the post data arguments on the system described by identifier
        Parameters:
        identifier - : node system identifier
        payload - : set boot source
        Throws:
        ApiException
      • getSystemEthernetInterfaceCollection

        public EthernetInterfaceCollectionEthernetInterfaceCollection getSystemEthernetInterfaceCollection(String identifier)
                                                                                                    throws ApiException
        • Web Target URI : /redfish/v1/Systems/{identifier}/EthernetInterfaces
        Retrieve the simple storage collection Defines a collection of ethernet interfaces that are present on the system described by identifier
        Parameters:
        identifier - : node system identifier
        Returns:
        EthernetInterfaceCollectionEthernetInterfaceCollection
        Throws:
        ApiException
      • getSystemEthernetInterface

        public EthernetInterface100EthernetInterface getSystemEthernetInterface(String identifier,
                                                                                String index)
                                                                         throws ApiException
        • Web Target URI : /redfish/v1/Systems/{identifier}/EthernetInterfaces/{index}
        Retrieve the ethernet interface by device identifier on node system Defines an ethernet interface present on the system described by identifier
        Parameters:
        identifier - : node system identifier
        index - : NIC on node system identifier
        Returns:
        EthernetInterface100EthernetInterface
        Throws:
        ApiException
      • getSimpleStorageCollection

        public SimpleStorageCollectionSimpleStorageCollection getSimpleStorageCollection(String identifier)
                                                                                  throws ApiException
        • Web Target URI : /redfish/v1/Systems/{identifier}/SimpleStorage/Controllers
        Retrieve the simple storage collection Defines a collection of simple storage collections that are present on the system described by identifier
        Parameters:
        identifier - : node system identifier
        Returns:
        SimpleStorageCollectionSimpleStorageCollection
        Throws:
        ApiException
      • getSimpleStorage

        public SimpleStorage100SimpleStorage getSimpleStorage(String identifier,
                                                              String index)
                                                       throws ApiException
        • Web Target URI : /redfish/v1/Systems/{identifier}/SimpleStorage/Controllers/{index}
        Retrieve the simple storage collection by device identifier Defines a collection of storage devices on the device specified by identifier that are present on the system described by identifier
        Parameters:
        identifier - : node system identifier
        index - : Simple Storage Device name
        Returns:
        SimpleStorage100SimpleStorage
        Throws:
        ApiException
      • getProcessorsCollection

        public ProcessorCollectionProcessorCollection getProcessorsCollection(String identifier)
                                                                       throws ApiException
        • Web Target URI : /redfish/v1/Systems/{identifier}/Processors
        Retrieve the processor collection for the specified system identifier defines a collection of processors contained within a resource.
        Parameters:
        identifier - : node system identifier
        Returns:
        ProcessorCollectionProcessorCollection
        Throws:
        ApiException
      • getSystemProcessor

        public Processor100Processor getSystemProcessor(String identifier,
                                                        String socket)
                                                 throws ApiException
        • Web Target URI : /redfish/v1/Systems/{identifier}/Processors/{socket}
        Retrieve a specified processor for the specified system identifier This represents the properties of a processor attached to a System.
        Parameters:
        identifier - : node system identifier
        socket - : CPU socket
        Returns:
        Processor100Processor
        Throws:
        ApiException
      • getJSONSchemaContent

        public JsonSchemaFile100JsonSchemaFile getJSONSchemaContent(String identifier)
                                                             throws ApiException
        • Web Target URI : /redfish/v1/JSONSchemas/{identifier}
        display the content of a schema json and reference links in Locations array
        Parameters:
        identifier - : JSON schema ID
        Returns:
        JsonSchemaFile100JsonSchemaFile
        Throws:
        ApiException
      • doSubmitTestEvent

        public void doSubmitTestEvent(EventService100SubmitTestEvent postBody)
                               throws ApiException
        • Post Target URI : /redfish/v1/EventService/Actions/EventService.SubmitTestEvent
        submit a test event action
        Parameters:
        postBody - : post object of submit a test event action
        Throws:
        ApiException
      • getEventSubscription

        public EventDestination100EventDestination getEventSubscription(String index)
                                                                 throws ApiException
        • Web Target URI : /redfish/v1/EventService/Subscriptions/{index}
        Retrieve specific event subscription
        Parameters:
        index - : specific event subscription
        Returns:
        EventDestination100EventDestination
        Throws:
        ApiException
      • postEventSubscription

        public void postEventSubscription(EventDestination100EventDestination payload,
                                          String index)
                                   throws ApiException
        • POST Target URI : /redfish/v1/EventService/Subscriptions/{index}
        Retrieve collection of subscribed events
        Parameters:
        payload - : post object of subscribed events
        index - : specific event subscription
        Throws:
        ApiException
      • deleteEventSubscription

        public void deleteEventSubscription(String index)
                                     throws ApiException
        • DELETE Target URI : /redfish/v1/EventService/Subscriptions/{index}
        Retrieve specific event subscription
        Parameters:
        index - : specific event subscription
        Throws:
        ApiException
      • getSessionInfo

        public Session100Session getSessionInfo(String index)
                                         throws ApiException
        • Web Target URI : /redfish/v1/Sessions/{index}
        Retrieve a sessions members list
        Parameters:
        index - : session ID
        Returns:
        Session100Session
        Throws:
        ApiException
      • deleteSession

        public void deleteSession(String index)
                           throws ApiException
        • Web Target URI : /redfish/v1/Sessions/{index}
        logout of the session
        Throws:
        ApiException
      • getTask

        public Task100Task getTask(String identifier)
                            throws ApiException
        • Web Target URI : /redfish/v1/TaskService/Tasks/{identifier}
        Retrieve a task entry by task Id
        Parameters:
        identifier - : Task ID
        Returns:
        Task100Task
        Throws:
        ApiException
      • RedfishSendRequest

        public <T> T RedfishSendRequest(String URI,
                                        String httpMethod,
                                        Object postBody,
                                        javax.ws.rs.core.GenericType<T> returnType)
                                 throws ApiException
        Retrieve server management resource data, send POST, PATCH request with postBody or DELETE target URI
        Parameters:
        URI - : target resource URI
        httpMethod - : HTTP request methods in Redfish support "GET", "POST", "PATCH" and "DELETE".
        postBody - : the java object of post data which using "POST" or "PATCH" method to send to target resource URI
        returnType - : deserialize the http response entity to given coresponding returnType
        Returns:
        < T > T : if returnType is not null then returned the coresponding response java object of receive data form target resource.
        Throws:
        ApiException

Copyright © 2017. All rights reserved.