vtn-vlan-map

Base Information

Groupings Summary

RPCs Summary

Groupings

• vtn-vlan-map-config

  • Description: Describes configuration for a VLAN mapping.
  • leaf: node
  • description: Identifier for a physical switch to be mapped. If this field is specified, only the VLAN specified by `vlan-id' on the specified physical switch is mapped to vBridge. If this field is omitted, the VLAN specified by `vlan-id' on all the switches managed by the OpenDaylight controller are mapped to vBridge.
  • type: (urn:opendaylight:inventory)node-id
  • leaf: vlan-id
  • description: Specifies the VLAN ID. Zero implies untagged Ethernet frame. If omitted, it will be treated as zero is specified.
  • type: (urn:opendaylight:l2:types)vlan-id

• vtn-vlan-mappable

  • Description: Describes the data model which can contain VLAN mapping configuration.
  • list: vlan-map
  • description: A list of VLAN mappings configured in this data model.
  • key definition: map-id
  • uses: vtn-vlan-map-info
  • refines:
  • leaf: map-id
  • description: The identifier assigned to the VLAN mapping, which is unique in the vBridge.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • container: vlan-map-config
  • description: The container which contains configuration for VLAN mapping.
  • uses: vtn-vlan-map-config
  • refines:
  • leaf: node
  • description: Identifier for a physical switch to be mapped. If this field is specified, only the VLAN specified by `vlan-id' on the specified physical switch is mapped to vBridge. If this field is omitted, the VLAN specified by `vlan-id' on all the switches managed by the OpenDaylight controller are mapped to vBridge.
  • type: (urn:opendaylight:inventory)node-id
  • leaf: vlan-id
  • description: Specifies the VLAN ID. Zero implies untagged Ethernet frame. If omitted, it will be treated as zero is specified.
  • type: (urn:opendaylight:l2:types)vlan-id
  • container: vlan-map-status
  • description: The container which contains runtime status information about VLAN mapping.
  • uses: vtn-vlan-map-status
  • refines:
  • leaf: active
  • description: Determine whether the VLAN mapping is active or not. True is set if VLAN specified by the VLAN mapping configuration is detected.
  • type: (urn:ietf:params:xml:ns:yang:1)boolean

• vtn-vlan-map-info

  • Description: Describes information about VLAN mapping, which associates a VLAN with a vBridge in VTN.
  • leaf: map-id
  • description: The identifier assigned to the VLAN mapping, which is unique in the vBridge.
  • type: (urn:ietf:params:xml:ns:yang:1)string
  • container: vlan-map-config
  • description: The container which contains configuration for VLAN mapping.
  • uses: vtn-vlan-map-config
  • refines:
  • leaf: node
  • description: Identifier for a physical switch to be mapped. If this field is specified, only the VLAN specified by `vlan-id' on the specified physical switch is mapped to vBridge. If this field is omitted, the VLAN specified by `vlan-id' on all the switches managed by the OpenDaylight controller are mapped to vBridge.
  • type: (urn:opendaylight:inventory)node-id
  • leaf: vlan-id
  • description: Specifies the VLAN ID. Zero implies untagged Ethernet frame. If omitted, it will be treated as zero is specified.
  • type: (urn:opendaylight:l2:types)vlan-id
  • container: vlan-map-status
  • description: The container which contains runtime status information about VLAN mapping.
  • uses: vtn-vlan-map-status
  • refines:
  • leaf: active
  • description: Determine whether the VLAN mapping is active or not. True is set if VLAN specified by the VLAN mapping configuration is detected.
  • type: (urn:ietf:params:xml:ns:yang:1)boolean

• vtn-vlan-map-status

  • Description: Describes runtime status information about VLAN mapping.
  • leaf: active
  • description: Determine whether the VLAN mapping is active or not. True is set if VLAN specified by the VLAN mapping configuration is detected.
  • type: (urn:ietf:params:xml:ns:yang:1)boolean

RPC Definitions

add-vlan-map

• Description: Configure VLAN mapping in the specified vBridge. VLAN specified by the RPC input will get mapped to the specified vBridge. Upon successful completion, the identifier assigned to the configured VLAN mapping and status status information about the VLAN mapping are set into the RPC output. On failure, one of vtn-error-tag value which indicates the cause of error is set into application tag in RPC error. `BADREQUEST' is set if the RPC input contains invalid data. `NOTFOUND' is set if the VTN specified by `tenant-name' is not present. `NOTFOUND' is set if the vBridge specified by `tenant-name' and `bridge-name' is not present. `CONFLICT' is set if the VLAN network speccified by the RPC input is already mapped to the specified vBridge or another vBridge. `INTERNALERROR' is set if the operation failed due to internal error.
• container: input
• uses: (urn:opendaylight:vtn:types)vbridge-path-fields
• refines:
• uses: vtn-vlan-map-config
• refines:
• leaf: tenant-name
• description: The name of the VTN.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: bridge-name
• description: The name of the vBridge.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: node
• description: Identifier for a physical switch to be mapped. If this field is specified, only the VLAN specified by `vlan-id' on the specified physical switch is mapped to vBridge. If this field is omitted, the VLAN specified by `vlan-id' on all the switches managed by the OpenDaylight controller are mapped to vBridge.
• type: (urn:opendaylight:inventory)node-id
• leaf: vlan-id
• description: Specifies the VLAN ID. Zero implies untagged Ethernet frame. If omitted, it will be treated as zero is specified.
• type: (urn:opendaylight:l2:types)vlan-id
• container: output
• uses: vtn-vlan-map-status
• refines:
• leaf: map-id
• description: The identifier assigned to newly configured VLAN mapping.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: active
• description: Determine whether the VLAN mapping is active or not. True is set if VLAN specified by the VLAN mapping configuration is detected.
• type: (urn:ietf:params:xml:ns:yang:1)boolean

get-vlan-map

• Description: Search for a VLAN mapping with the specified VLAN mapping configuration in the specified vBridge. If a VLAN mapping with the VLAN mapping configuration that exactly matches with the configuration specified by the RPC input is present in the specified vBridge, identifier assigned to that VLAN mapping and status information about the VLAN mapping are set to the RPC output. The RPC output will be empty if not found. On failure, one of vtn-error-tag value which indicates the cause of error is set into application tag in RPC error. `BADREQUEST' is set if the RPC input contains invalid data. `NOTFOUND' is set if the VTN or the vBridge specified by the RPC input is not present. `INTERNALERROR' is set if the operation failed due to internal error.
• container: input
• uses: (urn:opendaylight:vtn:types)vbridge-path-fields
• refines:
• uses: vtn-vlan-map-config
• refines:
• leaf: tenant-name
• description: The name of the VTN.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: bridge-name
• description: The name of the vBridge.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: node
• description: Identifier for a physical switch to be mapped. If this field is specified, only the VLAN specified by `vlan-id' on the specified physical switch is mapped to vBridge. If this field is omitted, the VLAN specified by `vlan-id' on all the switches managed by the OpenDaylight controller are mapped to vBridge.
• type: (urn:opendaylight:inventory)node-id
• leaf: vlan-id
• description: Specifies the VLAN ID. Zero implies untagged Ethernet frame. If omitted, it will be treated as zero is specified.
• type: (urn:opendaylight:l2:types)vlan-id
• container: output
• uses: vtn-vlan-map-status
• refines:
• leaf: map-id
• description: The identifier assigned to the VLAN mapping whose configuration exactly matches the configuration specified by the RPC input. Null is set if not found.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: active
• description: Determine whether the VLAN mapping is active or not. True is set if VLAN specified by the VLAN mapping configuration is detected.
• type: (urn:ietf:params:xml:ns:yang:1)boolean

remove-vlan-map

• Description: Remove the specified VLAN mappings from the vBridge. IDs for VLAN mappings passed to `map-ids' list will be copied to the RPC output, and `status' field in the RPC output describes the result of the operation. `REMOVED' indicates that the VLAN mapping specified by `map-id' field in the RPC output has been removed. Null indicates that the VLAN mapping specified by `map-id' field in the RPC output is not present. If no VLAN mapping ID is specified by the RPC input, all the VLAN mappings in the specified vBridge will be removed. In this case IDs for all the removed VLAN mappings will be copied to the RPC output. `remove-vlan-map-result' in the RPC output will be null if no VLAN mapping ID is specified by the RPC input and no VLAN mapping is configured in the specified vBridge. On failure, one of vtn-error-tag value which indicates the cause of error is set into application tag in RPC error. `BADREQUEST' is set if the RPC input contains invalid data. `NOTFOUND' is set if the VTN specified by `tenant-name' is not present. `NOTFOUND' is set if the vBridge specified by `tenant-name' and `bridge-name' is not present. `INTERNALERROR' is set if the operation failed due to internal error.
• container: input
• uses: (urn:opendaylight:vtn:types)vbridge-path-fields
• refines:
• leaf: tenant-name
• description: The name of the VTN.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: bridge-name
• description: The name of the vBridge.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf-list: map-ids
• description: A list of VLAN mapping IDs to be removed from the specified vBridge. If this field is omitted or an empty list is specified, all the VLAN mappings present in the specified vBridge will be removed. Duplicates in this list will be eliminated automatically.
• type: string
• container: output
• list: remove-vlan-map-result
• description: Describes pairs of VLAN mapping IDs and operation results.
• uses: (urn:opendaylight:vtn:types)vtn-rpc-result
• refines:
• leaf: map-id
• description: One of VLAN mapping ID specified by the RPC input.
• type: (urn:ietf:params:xml:ns:yang:1)string
• leaf: status
• description: Describes the status of the RPC result.
• type: (urn:opendaylight:vtn:types)vtn-update-type