sushy.resources.sessionservice package¶
Submodules¶
sushy.resources.sessionservice.session module¶
- class sushy.resources.sessionservice.session.Session(connector, identity, redfish_version=None, registries=None, root=None)¶
Bases:
ResourceBase- delete()¶
Method for deleting a Session.
- Raises:
ServerSideError
- description = <sushy.resources.base.Field object>¶
The session service description
- identity = <sushy.resources.base.Field object>¶
The session service identify string
- name = <sushy.resources.base.Field object>¶
The session service name
- username = <sushy.resources.base.Field object>¶
The UserName for the account for this session.
- class sushy.resources.sessionservice.session.SessionCollection(connector, identity, redfish_version=None, registries=None, root=None)¶
Bases:
ResourceCollectionBase- description = <sushy.resources.base.Field object>¶
The session collection description
- name = <sushy.resources.base.Field object>¶
The session collection name
sushy.resources.sessionservice.sessionservice module¶
- class sushy.resources.sessionservice.sessionservice.SessionService(connector, identity, redfish_version=None, registries=None, root=None)¶
Bases:
ResourceBase- close_session(session_uri)¶
This function is for closing a session based on its id.
- Raises:
ServerSideError
- create_session(username, password, target_uri=None)¶
This function will try to create a session.
Create a session and return the associated key and URI.
- Parameters:
username – the username of the user requesting a new session
password – the password associated to the user requesting a new session
target_uri – the “Sessions” uri, usually in the form: ‘/redfish/v1/SessionService/Sessions’
- Returns:
A session key and uri in the form of a tuple
- Raises:
MissingXAuthToken
- Raises:
ConnectionError
- Raises:
AccessError
- Raises:
HTTPError
- description = <sushy.resources.base.Field object>¶
The session service description
- identity = <sushy.resources.base.Field object>¶
The session service identify string
- name = <sushy.resources.base.Field object>¶
The session service name
- service_enabled = <sushy.resources.base.Field object>¶
Tells us if session service is enabled
- session_timeout = <sushy.resources.base.Field object>¶
The session service timeout
- property sessions¶
Property to provide reference to the SessionCollection instance
It is calculated once when the first time it is queried. On refresh, this property gets reset.
