Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712

Interface SecurityRuleAttributes

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    SecurityRule
    @Generated("mdsal-binding-generator")
public interface SecurityRuleAttributes
extends org.opendaylight.yangtools.yang.binding.DataObject
    OpenStack Layer3 Security Group rules.

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

     grouping security-rule-attributes {
   leaf direction {
     type identityref {
       base direction-base;
     }
   }
   leaf security-group-id {
     type yang:uuid;
   }
   leaf remote-group-id {
     type yang:uuid;
   }
   leaf remote-ip-prefix {
     type inet:ip-prefix;
   }
   leaf protocol {
     type union {
       type uint8;
       type identityref {
         base protocol-base;
       }
     }
   }
   leaf ethertype {
     type identityref {
       base ethertype-base;
     }
   }
   leaf port-range-min {
     type uint16;
   }
   leaf port-range-max {
     type uint16;
   }
 }
    The schema path to identify an instance is neutron-secgroups/security-rule-attributes

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

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

      • getDirection

        Class<? extends DirectionBase> getDirection()
        Return direction, or null if it is not present. 
             
         The direction in which metering rule is applied. For a compute instance, an
         ingress security group rule is applied to incoming (ingress) traffic for that
         instance. An egress rule is applied to traffic leaving the instance.
        Returns:
        Class<? extends DirectionBase> direction, or null if it is not present.

      • requireDirection

        default @NonNull Class<? extends DirectionBase> requireDirection()
        Return direction, guaranteed to be non-null. 
             
         The direction in which metering rule is applied. For a compute instance, an
         ingress security group rule is applied to incoming (ingress) traffic for that
         instance. An egress rule is applied to traffic leaving the instance.
        Returns:
        Class<? extends DirectionBase> direction, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if direction is not present

      • getSecurityGroupId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getSecurityGroupId()
        Return securityGroupId, or null if it is not present. 
             
         The security group ID to associate with this security group rule.
        Returns:
        Uuid securityGroupId, or null if it is not present.

      • requireSecurityGroupId

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireSecurityGroupId()
        Return securityGroupId, guaranteed to be non-null. 
             
         The security group ID to associate with this security group rule.
        Returns:
        Uuid securityGroupId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if securityGroupId is not present

      • getRemoteGroupId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getRemoteGroupId()
        Return remoteGroupId, or null if it is not present. 
             
         The remote group ID to be associated with this security group rule. You can
         specify either remote-ip-prefix or remote-group-id in the request body.
        Returns:
        Uuid remoteGroupId, or null if it is not present.

      • requireRemoteGroupId

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireRemoteGroupId()
        Return remoteGroupId, guaranteed to be non-null. 
             
         The remote group ID to be associated with this security group rule. You can
         specify either remote-ip-prefix or remote-group-id in the request body.
        Returns:
        Uuid remoteGroupId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if remoteGroupId is not present

      • getRemoteIpPrefix

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getRemoteIpPrefix()
        Return remoteIpPrefix, or null if it is not present. 
             
         The remote IP Prefix to be associated with this security group rule. You can
         specify either remote-ip-prefix or remote-group-id in the request body.
        Returns:
        IpPrefix remoteIpPrefix, or null if it is not present.

      • requireRemoteIpPrefix

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix requireRemoteIpPrefix()
        Return remoteIpPrefix, guaranteed to be non-null. 
             
         The remote IP Prefix to be associated with this security group rule. You can
         specify either remote-ip-prefix or remote-group-id in the request body.
        Returns:
        IpPrefix remoteIpPrefix, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if remoteIpPrefix is not present

      • getProtocol

        SecurityRuleAttributes.Protocol getProtocol()
        Return protocol, or null if it is not present. 
             
         The protocol that is matched by the security group rule.
        Returns:
        Protocol protocol, or null if it is not present.

      • requireProtocol

        default @NonNull SecurityRuleAttributes.Protocol requireProtocol()
        Return protocol, guaranteed to be non-null. 
             
         The protocol that is matched by the security group rule.
        Returns:
        Protocol protocol, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if protocol is not present

      • getEthertype

        Class<? extends EthertypeBase> getEthertype()
        Return ethertype, or null if it is not present. 
             
         Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress
         or egress rules.
        Returns:
        Class<? extends EthertypeBase> ethertype, or null if it is not present.

      • requireEthertype

        default @NonNull Class<? extends EthertypeBase> requireEthertype()
        Return ethertype, guaranteed to be non-null. 
             
         Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress
         or egress rules.
        Returns:
        Class<? extends EthertypeBase> ethertype, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if ethertype is not present

      • getPortRangeMin

        org.opendaylight.yangtools.yang.common.Uint16 getPortRangeMin()
        Return portRangeMin, or null if it is not present. 
             
         The minimum port number in the range that is matched by the security group rule.
         If the protocol is TCP or UDP, this value must be less than or equal to the
         value of the attribute. If the protocol is ICMP, this value must be an ICMP
         type.
        Returns:
        Uint16 portRangeMin, or null if it is not present.

      • requirePortRangeMin

        default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requirePortRangeMin()
        Return portRangeMin, guaranteed to be non-null. 
             
         The minimum port number in the range that is matched by the security group rule.
         If the protocol is TCP or UDP, this value must be less than or equal to the
         value of the attribute. If the protocol is ICMP, this value must be an ICMP
         type.
        Returns:
        Uint16 portRangeMin, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if portRangeMin is not present

      • getPortRangeMax

        org.opendaylight.yangtools.yang.common.Uint16 getPortRangeMax()
        Return portRangeMax, or null if it is not present. 
             
         The maximum port number in the range that is matched by the security group rule.
         If the protocol is TCP or UDP, this value must be less than or equal to the
         value of the attribute. If the protocol is ICMP, this value must be an ICMP
         type.
        Returns:
        Uint16 portRangeMax, or null if it is not present.

      • requirePortRangeMax

        default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requirePortRangeMax()
        Return portRangeMax, guaranteed to be non-null. 
             
         The maximum port number in the range that is matched by the security group rule.
         If the protocol is TCP or UDP, this value must be less than or equal to the
         value of the attribute. If the protocol is ICMP, this value must be an ICMP
         type.
        Returns:
        Uint16 portRangeMax, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if portRangeMax is not present