Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.aaa.rev200730

Interface AaaAuthenticationUserConfig

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
Config, State
@Generated("mdsal-binding-generator") public interface AaaAuthenticationUserConfig extends org.opendaylight.yangtools.yang.binding.DataObject
Configuration data for local users

This class represents the following YANG schema fragment defined in module openconfig-aaa 

 grouping aaa-authentication-user-config {
   leaf username {
     type string;
   }
   leaf password {
     type string;
     oc-ext:openconfig-hashed-value;
   }
   leaf password-hashed {
     type oc-aaa-types:crypt-password-type;
   }
   leaf ssh-key {
     type string;
   }
   leaf role {
     type union {
       type string;
       type identityref {
         base SYSTEM_DEFINED_ROLES;
       }
     }
   }
 }

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      Class<? extends AaaAuthenticationUserConfig> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

    • getUsername

      String getUsername()
      Return username, or null if it is not present. 
           
         Assigned username for this user
      Returns:
      String username, or null if it is not present.

    • requireUsername

      default @NonNull String requireUsername()
      Return username, guaranteed to be non-null. 
           
         Assigned username for this user
      Returns:
      String username, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if username is not present

    • getPassword

      String getPassword()
      Return password, or null if it is not present. 
           
         The user password, supplied as cleartext. The system must hash the value and
         only store the hashed value.
      Returns:
      String password, or null if it is not present.

    • requirePassword

      default @NonNull String requirePassword()
      Return password, guaranteed to be non-null. 
           
         The user password, supplied as cleartext. The system must hash the value and
         only store the hashed value.
      Returns:
      String password, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if password is not present

    • getPasswordHashed

      CryptPasswordType getPasswordHashed()
      Return passwordHashed, or null if it is not present. 
           
         The user password, supplied as a hashed value using the notation described in
         the definition of the crypt-password-type.
      Returns:
      CryptPasswordType passwordHashed, or null if it is not present.

    • requirePasswordHashed

      default @NonNull CryptPasswordType requirePasswordHashed()
      Return passwordHashed, guaranteed to be non-null. 
           
         The user password, supplied as a hashed value using the notation described in
         the definition of the crypt-password-type.
      Returns:
      CryptPasswordType passwordHashed, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if passwordHashed is not present

    • getSshKey

      String getSshKey()
      Return sshKey, or null if it is not present. 
           
         SSH public key for the user (RSA or DSA)
      Returns:
      String sshKey, or null if it is not present.

    • requireSshKey

      default @NonNull String requireSshKey()
      Return sshKey, guaranteed to be non-null. 
           
         SSH public key for the user (RSA or DSA)
      Returns:
      String sshKey, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if sshKey is not present

    • getRole

      AaaAuthenticationUserConfig.Role getRole()
      Return role, or null if it is not present. 
           
         Role assigned to the user. The role may be supplied as a string or a role
         defined by the SYSTEM_DEFINED_ROLES identity.
      Returns:
      Role role, or null if it is not present.

    • requireRole

      default @NonNull AaaAuthenticationUserConfig.Role requireRole()
      Return role, guaranteed to be non-null. 
           
         Role assigned to the user. The role may be supplied as a string or a role
         defined by the SYSTEM_DEFINED_ROLES identity.
      Returns:
      Role role, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if role is not present