sushy.resources.accountservice package

Submodules

sushy.resources.accountservice.account module

class sushy.resources.accountservice.account.ManagerAccount(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)

Bases: ResourceBase

account_types = <sushy.resources.base.MappedListField object>

The account types

delete()

Delete this account.

description = <sushy.resources.base.Field object>

Description

enabled = <sushy.resources.base.Field object>

Whether the account is enabled

identity = <sushy.resources.base.Field object>

The account identity string

locked = <sushy.resources.base.Field object>

Whether the account is locked

name = <sushy.resources.base.Field object>

The name of the resource

password_change_required = <sushy.resources.base.Field object>

Whether the service requires the password to be changed

role_id = <sushy.resources.base.Field object>

The role for this account

set_enabled(enabled)

Enable or disable this account.

Parameters:

enabled – Whether the account should be enabled.

set_locked(locked)

Lock or unlock this account.

Parameters:

locked – False to unlock the account.

set_password(password)

Set the account password.

This method doesn’t refresh or invalidate the resource.

Parameters:

password – The new password.

user_name = <sushy.resources.base.Field object>

The user name for the account

class sushy.resources.accountservice.account.ManagerAccountCollection(connector, path, redfish_version=None, registries=None, root=None)

Bases: MutableResourceCollectionBase

create_member(user_name, password, role_id)

Create a new account.

Parameters:

• user_name – The user name for the new account.

• password – The password for the new account.

• role_id – The role for the new account.

Returns:

The created ManagerAccount resource or None.

sushy.resources.accountservice.accountservice module

class sushy.resources.accountservice.accountservice.AccountService(connector, path='', redfish_version=None, registries=None, reader=None, json_doc=None, root=None)

Bases: ResourceBase

account_lockout_counter_reset_after = <sushy.resources.base.Field object>

Duration in seconds after which the failed login counter resets

account_lockout_duration = <sushy.resources.base.Field object>

Duration in seconds an account is locked after exceeding the lockout threshold

account_lockout_threshold = <sushy.resources.base.Field object>

Number of failed login attempts before the account is locked

property accounts

Property to reference the ManagerAccountCollection.

active_directory = <sushy.resources.accountservice.accountservice.ExternalAccountProviderField object>

Active Directory external account provider settings

property active_directory_certificates

Property to reference the Active Directory CertificateCollection.

description = <sushy.resources.base.Field object>

Description

identity = <sushy.resources.base.Field object>

The account service identity string

ldap = <sushy.resources.accountservice.accountservice.ExternalAccountProviderField object>

LDAP external account provider settings

property ldap_certificates

Property to reference the LDAP CertificateCollection.

local_account_auth = <sushy.resources.base.MappedField object>

Whether local accounts are authorized

max_password_length = <sushy.resources.base.Field object>

Maximum password length

min_password_length = <sushy.resources.base.Field object>

Minimum password length

name = <sushy.resources.base.Field object>

The name of the resource

service_enabled = <sushy.resources.base.Field object>

Whether the account service is enabled

status = <sushy.resources.common.StatusField object>

Describes the status and health of this resource.

class sushy.resources.accountservice.accountservice.AuthenticationField(*args, **kwargs)

Bases: CompositeField

authentication_type = <sushy.resources.base.MappedField object>

username = <sushy.resources.base.Field object>

class sushy.resources.accountservice.accountservice.ExternalAccountProviderField(*args, **kwargs)

Bases: CompositeField

authentication = <sushy.resources.accountservice.accountservice.AuthenticationField object>

ldap_service = <sushy.resources.accountservice.accountservice.LDAPServiceField object>

remote_role_mapping = <sushy.resources.accountservice.accountservice.RoleMappingField object>

service_addresses = <sushy.resources.base.Field object>

service_enabled = <sushy.resources.base.Field object>

class sushy.resources.accountservice.accountservice.LDAPSearchSettingsField(*args, **kwargs)

Bases: CompositeField

base_distinguished_names = <sushy.resources.base.Field object>

group_name_attribute = <sushy.resources.base.Field object>

groups_attribute = <sushy.resources.base.Field object>

username_attribute = <sushy.resources.base.Field object>

class sushy.resources.accountservice.accountservice.LDAPServiceField(*args, **kwargs)

Bases: CompositeField

search_settings = <sushy.resources.accountservice.accountservice.LDAPSearchSettingsField object>

class sushy.resources.accountservice.accountservice.RoleMappingField(*args, **kwargs)

Bases: ListField

local_role = <sushy.resources.base.Field object>

remote_group = <sushy.resources.base.Field object>

remote_user = <sushy.resources.base.Field object>

sushy.resources.accountservice.constants module

class sushy.resources.accountservice.constants.AccountTypes(*values)

Bases: Enum

HOST_CONSOLE = 'HostConsole'

IPMI = 'IPMI'

KVMIP = 'KVMIP'

MANAGER_CONSOLE = 'ManagerConsole'

OEM = 'OEM'

REDFISH = 'Redfish'

SNMP = 'SNMP'

VIRTUAL_MEDIA = 'VirtualMedia'

WEB_UI = 'WebUI'

class sushy.resources.accountservice.constants.AuthenticationType(*values)

Bases: Enum

KERBEROS_KEYTAB = 'KerberosKeytab'

OEM = 'OEM'

TOKEN = 'Token'

USERNAME_AND_PASSWORD = 'UsernameAndPassword'

class sushy.resources.accountservice.constants.LocalAccountAuth(*values)

Bases: Enum

DISABLED = 'Disabled'

ENABLED = 'Enabled'

FALLBACK = 'Fallback'

LOCAL_FIRST = 'LocalFirst'

Module contents