Interface IpsecconnectionAttributes

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    Ipsecsiteconnection

    @Generated("mdsal-binding-generator")
    public interface IpsecconnectionAttributes
    extends org.opendaylight.yangtools.yang.binding.DataObject

    This class represents the following YANG schema fragment defined in module neutron-vpnaas

     grouping ipsecconnection-attributes {
       leaf peer_address {
         type string;
       }
       leaf peer_id {
         type string;
       }
       leaf-list peer_cidrs {
         type string;
       }
       leaf route_mode {
         type string;
       }
       leaf mtu {
         type int16;
       }
       leaf auth_mode {
         type string;
       }
       leaf psk {
         type string;
       }
       leaf initiator {
         type string;
       }
       leaf ikepolicy-id {
         type yang:uuid;
       }
       leaf ipsecpolicy-id {
         type yang:uuid;
       }
       leaf vpnservice-id {
         type yang:uuid;
       }
       container dpd {
         leaf action {
           type string;
         }
         leaf interval {
           type int32;
         }
         leaf timeout {
           type int32;
         }
       }
     }
     
    The schema path to identify an instance is neutron-vpnaas/ipsecconnection-attributes
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • Method Detail

      • implementedInterface

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

        String getPeerAddress()
        Return peerAddress, or null if it is not present.
             
                 Peer gateway public IPv4/IPv6 address or FQDN
             
         
        Returns:
        String peerAddress, or null if it is not present.
      • requirePeerAddress

        default @NonNull String requirePeerAddress()
        Return peerAddress, guaranteed to be non-null.
             
                 Peer gateway public IPv4/IPv6 address or FQDN
             
         
        Returns:
        String peerAddress, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if peerAddress is not present
      • getPeerId

        String getPeerId()
        Return peerId, or null if it is not present.
             
                 Peer router identity for authentication
             
         
        Returns:
        String peerId, or null if it is not present.
      • requirePeerId

        default @NonNull String requirePeerId()
        Return peerId, guaranteed to be non-null.
             
                 Peer router identity for authentication
             
         
        Returns:
        String peerId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if peerId is not present
      • getPeerCidrs

        @Nullable List<String> getPeerCidrs()
        Return peerCidrs, or null if it is not present.
             
                 Unique list of valid peer private CIDRs in the form
                 &lt;net_address&gt;/&lt;prefix&gt;
             
         
        Returns:
        List<String> peerCidrs, or null if it is not present.
      • requirePeerCidrs

        default @NonNull List<String> requirePeerCidrs()
        Return peerCidrs, guaranteed to be non-null.
             
                 Unique list of valid peer private CIDRs in the form
                 &lt;net_address&gt;/&lt;prefix&gt;
             
         
        Returns:
        List<String> peerCidrs, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if peerCidrs is not present
      • getRouteMode

        String getRouteMode()
        Return routeMode, or null if it is not present.
             
                 Route mode
             
         
        Returns:
        String routeMode, or null if it is not present.
      • requireRouteMode

        default @NonNull String requireRouteMode()
        Return routeMode, guaranteed to be non-null.
             
                 Route mode
             
         
        Returns:
        String routeMode, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if routeMode is not present
      • getMtu

        Short getMtu()
        Return mtu, or null if it is not present.
             
                 Maximum Transmission Unit to address fragmentation
             
         
        Returns:
        Short mtu, or null if it is not present.
      • requireMtu

        default @NonNull Short requireMtu()
        Return mtu, guaranteed to be non-null.
             
                 Maximum Transmission Unit to address fragmentation
             
         
        Returns:
        Short mtu, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if mtu is not present
      • getAuthMode

        String getAuthMode()
        Return authMode, or null if it is not present.
             
                 Authentication mode
             
         
        Returns:
        String authMode, or null if it is not present.
      • requireAuthMode

        default @NonNull String requireAuthMode()
        Return authMode, guaranteed to be non-null.
             
                 Authentication mode
             
         
        Returns:
        String authMode, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if authMode is not present
      • getPsk

        String getPsk()
        Return psk, or null if it is not present.
             
                 Pre Shared Key
             
         
        Returns:
        String psk, or null if it is not present.
      • requirePsk

        default @NonNull String requirePsk()
        Return psk, guaranteed to be non-null.
             
                 Pre Shared Key
             
         
        Returns:
        String psk, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if psk is not present
      • getInitiator

        String getInitiator()
        Return initiator, or null if it is not present.
             
                 Whether this VPN can only respond to connections, response-only, or can initiate
                 as well, bi-directional(default).
             
         
        Returns:
        String initiator, or null if it is not present.
      • requireInitiator

        default @NonNull String requireInitiator()
        Return initiator, guaranteed to be non-null.
             
                 Whether this VPN can only respond to connections, response-only, or can initiate
                 as well, bi-directional(default).
             
         
        Returns:
        String initiator, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if initiator is not present
      • getIkepolicyId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getIkepolicyId()
        Return ikepolicyId, or null if it is not present.
             
                 Unique identifier of IKE policy.
             
         
        Returns:
        Uuid ikepolicyId, or null if it is not present.
      • requireIkepolicyId

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireIkepolicyId()
        Return ikepolicyId, guaranteed to be non-null.
             
                 Unique identifier of IKE policy.
             
         
        Returns:
        Uuid ikepolicyId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if ikepolicyId is not present
      • getIpsecpolicyId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getIpsecpolicyId()
        Return ipsecpolicyId, or null if it is not present.
             
                 Unique identifier of IPSec policy.
             
         
        Returns:
        Uuid ipsecpolicyId, or null if it is not present.
      • requireIpsecpolicyId

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireIpsecpolicyId()
        Return ipsecpolicyId, guaranteed to be non-null.
             
                 Unique identifier of IPSec policy.
             
         
        Returns:
        Uuid ipsecpolicyId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if ipsecpolicyId is not present
      • getVpnserviceId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getVpnserviceId()
        Return vpnserviceId, or null if it is not present.
             
                 Unique identifier of VPN service.
             
         
        Returns:
        Uuid vpnserviceId, or null if it is not present.
      • requireVpnserviceId

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireVpnserviceId()
        Return vpnserviceId, guaranteed to be non-null.
             
                 Unique identifier of VPN service.
             
         
        Returns:
        Uuid vpnserviceId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if vpnserviceId is not present
      • getDpd

        Dpd getDpd()
        Return dpd, or null if it is not present.
             
                 Dead Peer Detection protocol controls
             
         
        Returns:
        Dpd dpd, or null if it is not present.