Interface AaaRadiusServerConfig

  • All Superinterfaces:
    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 AaaRadiusServerConfig
    extends org.opendaylight.yangtools.yang.binding.DataObject
    Configuration data for a RADIUS server

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

     grouping aaa-radius-server-config {
       leaf auth-port {
         type oc-inet:port-number;
         default 1812;
       }
       leaf acct-port {
         type oc-inet:port-number;
         default 1813;
       }
       leaf secret-key {
         type oc-types:routing-password;
       }
       leaf secret-key-hashed {
         type oc-aaa-types:crypt-password-type;
       }
       leaf source-address {
         type oc-inet:ip-address;
       }
       leaf retransmit-attempts {
         type uint8;
       }
     }
     
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        PortNumber getAuthPort()
        Return authPort, or null if it is not present.
             
                 Port number for authentication requests
             
         
        Returns:
        PortNumber authPort, or null if it is not present.
      • requireAuthPort

        default @NonNull PortNumber requireAuthPort()
        Return authPort, guaranteed to be non-null.
             
                 Port number for authentication requests
             
         
        Returns:
        PortNumber authPort, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if authPort is not present
      • getAcctPort

        PortNumber getAcctPort()
        Return acctPort, or null if it is not present.
             
                 Port number for accounting requests
             
         
        Returns:
        PortNumber acctPort, or null if it is not present.
      • requireAcctPort

        default @NonNull PortNumber requireAcctPort()
        Return acctPort, guaranteed to be non-null.
             
                 Port number for accounting requests
             
         
        Returns:
        PortNumber acctPort, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if acctPort is not present
      • getSecretKey

        RoutingPassword getSecretKey()
        Return secretKey, or null if it is not present.
             
                 The unencrypted shared key used between the authentication server and the
                 device.
             
         
        Returns:
        RoutingPassword secretKey, or null if it is not present.
      • requireSecretKey

        default @NonNull RoutingPassword requireSecretKey()
        Return secretKey, guaranteed to be non-null.
             
                 The unencrypted shared key used between the authentication server and the
                 device.
             
         
        Returns:
        RoutingPassword secretKey, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if secretKey is not present
      • getSecretKeyHashed

        CryptPasswordType getSecretKeyHashed()
        Return secretKeyHashed, or null if it is not present.
             
                 The hashed shared key used between the authentication server and the device.
             
         
        Returns:
        CryptPasswordType secretKeyHashed, or null if it is not present.
      • requireSecretKeyHashed

        default @NonNull CryptPasswordType requireSecretKeyHashed()
        Return secretKeyHashed, guaranteed to be non-null.
             
                 The hashed shared key used between the authentication server and the device.
             
         
        Returns:
        CryptPasswordType secretKeyHashed, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if secretKeyHashed is not present
      • getSourceAddress

        IpAddress getSourceAddress()
        Return sourceAddress, or null if it is not present.
             
                 Source IP address to use in messages to the RADIUS server
             
         
        Returns:
        IpAddress sourceAddress, or null if it is not present.
      • requireSourceAddress

        default @NonNull IpAddress requireSourceAddress()
        Return sourceAddress, guaranteed to be non-null.
             
                 Source IP address to use in messages to the RADIUS server
             
         
        Returns:
        IpAddress sourceAddress, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if sourceAddress is not present
      • getRetransmitAttempts

        org.opendaylight.yangtools.yang.common.Uint8 getRetransmitAttempts()
        Return retransmitAttempts, or null if it is not present.
             
                 Number of times the system may resend a request to the RADIUS server when it is
                 unresponsive
             
         
        Returns:
        Uint8 retransmitAttempts, or null if it is not present.
      • requireRetransmitAttempts

        default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireRetransmitAttempts()
        Return retransmitAttempts, guaranteed to be non-null.
             
                 Number of times the system may resend a request to the RADIUS server when it is
                 unresponsive
             
         
        Returns:
        Uint8 retransmitAttempts, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if retransmitAttempts is not present