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
    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 Summary

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @Nullable Class<? extends DirectionBase> getDirection()
      The direction in which metering rule is applied.
      @Nullable Class<? extends EthertypeBase> getEthertype()
      Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules.
      @Nullable org.opendaylight.yangtools.yang.common.Uint16 getPortRangeMax()
      The maximum port number in the range that is matched by the security group rule.
      @Nullable org.opendaylight.yangtools.yang.common.Uint16 getPortRangeMin()
      The minimum port number in the range that is matched by the security group rule.
      @Nullable SecurityRuleAttributes.Protocol getProtocol()
      The protocol that is matched by the security group rule.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getRemoteGroupId()
      The remote group ID to be associated with this security group rule.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getRemoteIpPrefix()
      The remote IP Prefix to be associated with this security group rule.
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getSecurityGroupId()
      The security group ID to associate with this security group rule.
      Class<? extends SecurityRuleAttributes> implementedInterface()  

    • 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

        @Nullable Class<? extends DirectionBase> getDirection()
        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:
        java.lang.Class direction, or null if not present

      • getSecurityGroupId

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

      • getRemoteGroupId

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getRemoteGroupId()
        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:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid remoteGroupId, or null if not present

      • getRemoteIpPrefix

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getRemoteIpPrefix()
        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:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix remoteIpPrefix, or null if not present

      • getProtocol

        @Nullable SecurityRuleAttributes.Protocol getProtocol()
        The protocol that is matched by the security group rule.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.secgroups.rev150712.SecurityRuleAttributes.Protocol protocol, or null if not present

      • getEthertype

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

      • getPortRangeMin

        @Nullable org.opendaylight.yangtools.yang.common.Uint16 getPortRangeMin()
        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:
        org.opendaylight.yangtools.yang.common.Uint16 portRangeMin, or null if not present

      • getPortRangeMax

        @Nullable org.opendaylight.yangtools.yang.common.Uint16 getPortRangeMax()
        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:
        org.opendaylight.yangtools.yang.common.Uint16 portRangeMax, or null if not present