Rest API Reference

vnc_cfg_api_server Package

The main modules in this package are:
  • vnc_cfg_api_server
  • gen.resource_common
  • gen.resource_xsd
  • vnc_cfg_ifmap
  • vnc_addr_mgmt
  • vnc_cfg_types
  • vnc_cpu_info

resource_common Module

This module defines the classes for every configuration element managed by the system

class vnc_cfg_api_server.gen.resource_common.AccessControlList(name=None, parent_obj=None, access_control_list_entries=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents access-control-list configuration representation.

Child of:
VirtualNetwork object OR SecurityGroup object OR
Properties:
  • access_control_list_entries

    Type: AclEntriesType

    Created By: System

    Operations Allowed: CRUD

    Description:

    Automatically generated by system based on security groups or network policies.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

access_control_list_entries

Get access-control-list-entries for access-control-list.

Returns:AclEntriesType object
display_name

Get display-name for access-control-list.

Returns:xsd:string object
dump()

Display access-control-list object in compact form.

get_fq_name()

Return FQN of access-control-list in list form.

get_fq_name_str()

Return FQN of access-control-list as colon delimited string.

get_parent_fq_name()

Return FQN of access-control-list’s parent in list form.

get_parent_fq_name_str()

Return FQN of access-control-list’s parent as colon delimted string.

get_type()

Return object type (access-control-list).

id_perms

Get id-perms for access-control-list.

Returns:IdPermsType object
perms2

Get perms2 for access-control-list.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.Alarm(name=None, parent_obj=None, uve_keys=None, alarm_severity=None, alarm_rules=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents alarm configuration representation.

Child of:
GlobalSystemConfig object OR Project object OR
Properties:
  • uve_keys

    Type: string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    List of UVE tables or UVE objects where this alarm config should be applied. For example, rules

    based on NodeStatus UVE can be applied to multiple object types such as analytics-node, config-node,

    control-node, etc., Alarm config may also be applied to specific objects that can be specified as

    <uve-table-name>.<uve-name>

  • alarm_severity

    Type: int, within [0, 7]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Severity level for the alarm.

  • alarm_rules

    Type: AlarmOrList

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Rules based on the UVE attributes specified as OR-of-ANDs of AlarmExpression template. Example:

    “alarm_rules”: {“or_list”: [{“and_list”: [{AlarmExpression1}, {AlarmExpression2}, ...]},

    {“and_list”: [{AlarmExpression3}, {AlarmExpression4}, ...]}]}

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

alarm_rules

Get alarm-rules for alarm.

Returns:AlarmOrList object
alarm_severity

Get alarm-severity for alarm.

Returns:AlarmSeverity object
display_name

Get display-name for alarm.

Returns:xsd:string object
dump()

Display alarm object in compact form.

get_fq_name()

Return FQN of alarm in list form.

get_fq_name_str()

Return FQN of alarm as colon delimited string.

get_parent_fq_name()

Return FQN of alarm’s parent in list form.

get_parent_fq_name_str()

Return FQN of alarm’s parent as colon delimted string.

get_type()

Return object type (alarm).

id_perms

Get id-perms for alarm.

Returns:IdPermsType object
perms2

Get perms2 for alarm.

Returns:PermType2 object
uve_keys

Get uve-keys for alarm.

Returns:xsd:string object
class vnc_cfg_api_server.gen.resource_common.AliasIp(name=None, parent_obj=None, alias_ip_address=None, alias_ip_address_family=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents alias-ip configuration representation.

Child of:
AliasIpPool object OR
Properties:
  • alias_ip_address

    Type: string, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CR

    Description:

    Alias ip address.

  • alias_ip_address_family

    Type: string, one-of [u’v4’, u’v6’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Ip address family of the alias ip, IpV4 or IpV6

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of Project objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Reference to project from which this alias ip was allocated.

  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to virtual machine interface to which this alias ip is attached.

Referred by:

add_project(ref_obj)

Add project to alias-ip.

Parameters:ref_obj – Project object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to alias-ip.

Parameters:ref_obj – VirtualMachineInterface object
alias_ip_address

Get alias-ip-address for alias-ip.

Returns:IpAddressType object
alias_ip_address_family

Get alias-ip-address-family for alias-ip.

Returns:IpAddressFamilyType object
display_name

Get display-name for alias-ip.

Returns:xsd:string object
dump()

Display alias-ip object in compact form.

get_fq_name()

Return FQN of alias-ip in list form.

get_fq_name_str()

Return FQN of alias-ip as colon delimited string.

get_parent_fq_name()

Return FQN of alias-ip’s parent in list form.

get_parent_fq_name_str()

Return FQN of alias-ip’s parent as colon delimted string.

get_project_refs()

Return project list for alias-ip.

Returns:list of <Project>
get_type()

Return object type (alias-ip).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for alias-ip.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for alias-ip.

Returns:IdPermsType object
perms2

Get perms2 for alias-ip.

Returns:PermType2 object
set_project(ref_obj)

Set project for alias-ip.

Parameters:ref_obj – Project object
set_project_list(ref_obj_list)

Set project list for alias-ip.

Parameters:ref_obj_list – list of Project object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for alias-ip.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for alias-ip.

Parameters:ref_obj_list – list of VirtualMachineInterface object
class vnc_cfg_api_server.gen.resource_common.AliasIpPool(name=None, parent_obj=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents alias-ip-pool configuration representation.

Child of:
VirtualNetwork object OR
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of AliasIp objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    alias ip is a ip that can be assigned to virtual-machine-interface(VMI), By doing so VMI can now be

    part of the alias ip network. packets originating with alias-ip as the source-ip belongs to alias-

    ip-network

References to:

Referred by:
display_name

Get display-name for alias-ip-pool.

Returns:xsd:string object
dump()

Display alias-ip-pool object in compact form.

get_fq_name()

Return FQN of alias-ip-pool in list form.

get_fq_name_str()

Return FQN of alias-ip-pool as colon delimited string.

get_parent_fq_name()

Return FQN of alias-ip-pool’s parent in list form.

get_parent_fq_name_str()

Return FQN of alias-ip-pool’s parent as colon delimted string.

get_project_back_refs()

Return list of all projects using this alias-ip-pool

get_type()

Return object type (alias-ip-pool).

id_perms

Get id-perms for alias-ip-pool.

Returns:IdPermsType object
perms2

Get perms2 for alias-ip-pool.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.AnalyticsNode(name=None, parent_obj=None, analytics_node_ip_address=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents analytics-node configuration representation.

Child of:
GlobalSystemConfig object OR
Properties:
  • analytics_node_ip_address

    Type: string, one-of xsd:string

    Created By: User (admin-only)

    Operations Allowed: CRUD

    Description:

    Ip address of the analytics node, set while provisioning.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

analytics_node_ip_address

Get analytics-node-ip-address for analytics-node.

Returns:IpAddressType object
display_name

Get display-name for analytics-node.

Returns:xsd:string object
dump()

Display analytics-node object in compact form.

get_fq_name()

Return FQN of analytics-node in list form.

get_fq_name_str()

Return FQN of analytics-node as colon delimited string.

get_parent_fq_name()

Return FQN of analytics-node’s parent in list form.

get_parent_fq_name_str()

Return FQN of analytics-node’s parent as colon delimted string.

get_type()

Return object type (analytics-node).

id_perms

Get id-perms for analytics-node.

Returns:IdPermsType object
perms2

Get perms2 for analytics-node.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.ApiAccessList(name=None, parent_obj=None, api_access_list_entries=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents api-access-list configuration representation.

Child of:
Domain object OR Project object OR GlobalSystemConfig object OR
Properties:
  • api_access_list_entries

    Type: RbacRuleEntriesType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    List of rules e.g network.* => admin:CRUD (admin can perform all ops on networks).

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

api_access_list_entries

Get api-access-list-entries for api-access-list.

Returns:RbacRuleEntriesType object
display_name

Get display-name for api-access-list.

Returns:xsd:string object
dump()

Display api-access-list object in compact form.

get_fq_name()

Return FQN of api-access-list in list form.

get_fq_name_str()

Return FQN of api-access-list as colon delimited string.

get_parent_fq_name()

Return FQN of api-access-list’s parent in list form.

get_parent_fq_name_str()

Return FQN of api-access-list’s parent as colon delimted string.

get_type()

Return object type (api-access-list).

id_perms

Get id-perms for api-access-list.

Returns:IdPermsType object
perms2

Get perms2 for api-access-list.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.BgpAsAService(name=None, parent_obj=None, autonomous_system=None, bgpaas_ip_address=None, bgpaas_session_attributes=None, bgpaas_ipv4_mapped_ipv6_nexthop=None, bgpaas_suppress_route_advertisement=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents bgp-as-a-service configuration representation.

Child of:
Project object OR
Properties:
  • autonomous_system

    Type: int, within [1, 65534]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    16 bit BGP Autonomous System number for the cluster.

  • bgpaas_ip_address

    Type: string, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Ip address of the BGP peer.

  • bgpaas_session_attributes

    Type: BgpSessionAttributes

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    BGP peering session attributes.

  • bgpaas_ipv4_mapped_ipv6_nexthop

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    True when client bgp implementation expects to receive a ipv4-mapped ipv6 address (as opposed to

    regular ipv6 address) as the bgp nexthop for ipv6 routes.

  • bgpaas_suppress_route_advertisement

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    True when server should not advertise any routes to the client i.e. the client has static routes

    (typically a default) configured.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualMachineInterface objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Reference to VMI on which BGPaaS BGP peering will happen.

  • list of BgpRouter objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Reference to internal BGP peer object automatically generated by the system.

Referred by:

add_bgp_router(ref_obj)

Add bgp-router to bgp-as-a-service.

Parameters:ref_obj – BgpRouter object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to bgp-as-a-service.

Parameters:ref_obj – VirtualMachineInterface object
autonomous_system

Get autonomous-system for bgp-as-a-service.

Returns:AutonomousSystemType object
bgpaas_ip_address

Get bgpaas-ip-address for bgp-as-a-service.

Returns:IpAddressType object
bgpaas_ipv4_mapped_ipv6_nexthop

Get bgpaas-ipv4-mapped-ipv6-nexthop for bgp-as-a-service.

Returns:xsd:boolean object
bgpaas_session_attributes

Get bgpaas-session-attributes for bgp-as-a-service.

Returns:BgpSessionAttributes object
bgpaas_suppress_route_advertisement

Get bgpaas-suppress-route-advertisement for bgp-as-a-service.

Returns:xsd:boolean object
display_name

Get display-name for bgp-as-a-service.

Returns:xsd:string object
dump()

Display bgp-as-a-service object in compact form.

get_bgp_router_refs()

Return bgp-router list for bgp-as-a-service.

Returns:list of <BgpRouter>
get_fq_name()

Return FQN of bgp-as-a-service in list form.

get_fq_name_str()

Return FQN of bgp-as-a-service as colon delimited string.

get_parent_fq_name()

Return FQN of bgp-as-a-service’s parent in list form.

get_parent_fq_name_str()

Return FQN of bgp-as-a-service’s parent as colon delimted string.

get_type()

Return object type (bgp-as-a-service).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for bgp-as-a-service.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for bgp-as-a-service.

Returns:IdPermsType object
perms2

Get perms2 for bgp-as-a-service.

Returns:PermType2 object
set_bgp_router(ref_obj)

Set bgp-router for bgp-as-a-service.

Parameters:ref_obj – BgpRouter object
set_bgp_router_list(ref_obj_list)

Set bgp-router list for bgp-as-a-service.

Parameters:ref_obj_list – list of BgpRouter object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for bgp-as-a-service.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for bgp-as-a-service.

Parameters:ref_obj_list – list of VirtualMachineInterface object
class vnc_cfg_api_server.gen.resource_common.BgpRouter(name=None, parent_obj=None, bgp_router_parameters=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents bgp-router configuration representation.

Child of:
RoutingInstance object OR
Properties:
  • bgp_router_parameters

    Type: BgpRouterParams

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    BGP router configuration parameters like ip address, AS number, hold time etc.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of (BgpRouter object, BgpPeeringAttributes attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    References to peer BGP router, property of the reference has BGP peering attributes.

Referred by:
add_bgp_router(ref_obj, ref_data)

Add bgp-router to bgp-router.

Parameters:
  • ref_obj – BgpRouter object
  • ref_data – BgpPeeringAttributes object
bgp_router_parameters

Get bgp-router-parameters for bgp-router.

Returns:BgpRouterParams object
display_name

Get display-name for bgp-router.

Returns:xsd:string object
dump()

Display bgp-router object in compact form.

get_bgp_as_a_service_back_refs()

Return list of all bgp-as-a-services using this bgp-router

get_bgp_router_back_refs()

Return list of all bgp-routers using this bgp-router

get_bgp_router_refs()

Return bgp-router list for bgp-router.

Returns:list of tuple <BgpRouter, BgpPeeringAttributes>
get_fq_name()

Return FQN of bgp-router in list form.

get_fq_name_str()

Return FQN of bgp-router as colon delimited string.

get_global_system_config_back_refs()

Return list of all global-system-configs using this bgp-router

get_parent_fq_name()

Return FQN of bgp-router’s parent in list form.

get_parent_fq_name_str()

Return FQN of bgp-router’s parent as colon delimted string.

get_physical_router_back_refs()

Return list of all physical-routers using this bgp-router

get_type()

Return object type (bgp-router).

id_perms

Get id-perms for bgp-router.

Returns:IdPermsType object
perms2

Get perms2 for bgp-router.

Returns:PermType2 object
set_bgp_router(ref_obj, ref_data)

Set bgp-router for bgp-router.

Parameters:
  • ref_obj – BgpRouter object
  • ref_data – BgpPeeringAttributes object
set_bgp_router_list(ref_obj_list, ref_data_list)

Set bgp-router list for bgp-router.

Parameters:
  • ref_obj_list – list of BgpRouter object
  • ref_data_list – list of BgpPeeringAttributes object
class vnc_cfg_api_server.gen.resource_common.ConfigNode(name=None, parent_obj=None, config_node_ip_address=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents config-node configuration representation.

Child of:
GlobalSystemConfig object OR
Properties:
  • config_node_ip_address

    Type: string, one-of xsd:string

    Created By: User (admin-only)

    Operations Allowed: CRUD

    Description:

    Ip address of the config node, set while provisioning.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

config_node_ip_address

Get config-node-ip-address for config-node.

Returns:IpAddressType object
display_name

Get display-name for config-node.

Returns:xsd:string object
dump()

Display config-node object in compact form.

get_fq_name()

Return FQN of config-node in list form.

get_fq_name_str()

Return FQN of config-node as colon delimited string.

get_parent_fq_name()

Return FQN of config-node’s parent in list form.

get_parent_fq_name_str()

Return FQN of config-node’s parent as colon delimted string.

get_type()

Return object type (config-node).

id_perms

Get id-perms for config-node.

Returns:IdPermsType object
perms2

Get perms2 for config-node.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.ConfigRoot(name=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents config-root configuration representation.

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of GlobalSystemConfig objects

    Created By: User (required)

    Operations Allowed: R

    Description:

    Global system config is object where all global system configuration is present.

  • list of Domain objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Domain is authentication namespace, a collection of projects.

References to:

Referred by:

display_name

Get display-name for config-root.

Returns:xsd:string object
dump()

Display config-root object in compact form.

get_fq_name()

Return FQN of config-root in list form.

get_fq_name_str()

Return FQN of config-root as colon delimited string.

get_type()

Return object type (config-root).

id_perms

Get id-perms for config-root.

Returns:IdPermsType object
perms2

Get perms2 for config-root.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.CustomerAttachment(name=None, attachment_address=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents customer-attachment configuration representation.

Properties:
  • attachment_address

    Type: AttachmentAddressType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Not in Use.

  • list of FloatingIp objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Not in Use.

Referred by:

add_floating_ip(ref_obj)

Add floating-ip to customer-attachment.

Parameters:ref_obj – FloatingIp object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to customer-attachment.

Parameters:ref_obj – VirtualMachineInterface object
attachment_address

Get attachment-address for customer-attachment.

Returns:AttachmentAddressType object
display_name

Get display-name for customer-attachment.

Returns:xsd:string object
dump()

Display customer-attachment object in compact form.

get_floating_ip_refs()

Return floating-ip list for customer-attachment.

Returns:list of <FloatingIp>
get_fq_name()

Return FQN of customer-attachment in list form.

get_fq_name_str()

Return FQN of customer-attachment as colon delimited string.

get_type()

Return object type (customer-attachment).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for customer-attachment.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for customer-attachment.

Returns:IdPermsType object
perms2

Get perms2 for customer-attachment.

Returns:PermType2 object
set_floating_ip(ref_obj)

Set floating-ip for customer-attachment.

Parameters:ref_obj – FloatingIp object
set_floating_ip_list(ref_obj_list)

Set floating-ip list for customer-attachment.

Parameters:ref_obj_list – list of FloatingIp object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for customer-attachment.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for customer-attachment.

Parameters:ref_obj_list – list of VirtualMachineInterface object
class vnc_cfg_api_server.gen.resource_common.DatabaseNode(name=None, parent_obj=None, database_node_ip_address=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents database-node configuration representation.

Child of:
GlobalSystemConfig object OR
Properties:
  • database_node_ip_address

    Type: string, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Ip address of the database node, set while provisioning.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

database_node_ip_address

Get database-node-ip-address for database-node.

Returns:IpAddressType object
display_name

Get display-name for database-node.

Returns:xsd:string object
dump()

Display database-node object in compact form.

get_fq_name()

Return FQN of database-node in list form.

get_fq_name_str()

Return FQN of database-node as colon delimited string.

get_parent_fq_name()

Return FQN of database-node’s parent in list form.

get_parent_fq_name_str()

Return FQN of database-node’s parent as colon delimted string.

get_type()

Return object type (database-node).

id_perms

Get id-perms for database-node.

Returns:IdPermsType object
perms2

Get perms2 for database-node.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.DiscoveryServiceAssignment(name=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents discovery-service-assignment configuration representation.

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of DsaRule objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Discovery service rule for assigning subscriber to publisher. (set of subscriber) can be assigned to

    (set of publisher).

References to:

Referred by:

display_name

Get display-name for discovery-service-assignment.

Returns:xsd:string object
dump()

Display discovery-service-assignment object in compact form.

get_fq_name()

Return FQN of discovery-service-assignment in list form.

get_fq_name_str()

Return FQN of discovery-service-assignment as colon delimited string.

get_type()

Return object type (discovery-service-assignment).

id_perms

Get id-perms for discovery-service-assignment.

Returns:IdPermsType object
perms2

Get perms2 for discovery-service-assignment.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.Domain(name=None, parent_obj=None, domain_limits=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents domain configuration representation.

Child of:
ConfigRoot object OR
Properties:
  • domain_limits

    Type: DomainLimitsType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Domain level Qouta, not currently implemented

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of Project objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Project represent one instance of application or tenant.

  • list of Namespace objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Namespace is unique networking namespace within this domain. If namespace is not present then

    default namespace of default project is used.

  • list of ServiceTemplate objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Service templete defines how a service may be deployed in the network. Service instance is

    instantiated from config in service templete.

  • list of VirtualDns objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Virtual DNS server is DNS as service for tenants. It is inbound DNS servce for virtual machines in

    this project. DNS requests by end points inside this project/IPAM are served by this DNS server

    rules.

  • list of ApiAccessList objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    API access list is list of rules that define role based access to each API and its properties at

    doamin level.

References to:

Referred by:

display_name

Get display-name for domain.

Returns:xsd:string object
domain_limits

Get domain-limits for domain.

Returns:DomainLimitsType object
dump()

Display domain object in compact form.

get_fq_name()

Return FQN of domain in list form.

get_fq_name_str()

Return FQN of domain as colon delimited string.

get_parent_fq_name()

Return FQN of domain’s parent in list form.

get_parent_fq_name_str()

Return FQN of domain’s parent as colon delimted string.

get_type()

Return object type (domain).

id_perms

Get id-perms for domain.

Returns:IdPermsType object
perms2

Get perms2 for domain.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.DsaRule(name=None, parent_obj=None, dsa_rule_entry=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents dsa-rule configuration representation.

Child of:
DiscoveryServiceAssignment object OR
Properties:
  • dsa_rule_entry

    Type: DiscoveryServiceAssignmentType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    rule entry defining pubisher set and subscriber set.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

display_name

Get display-name for dsa-rule.

Returns:xsd:string object
dsa_rule_entry

Get dsa-rule-entry for dsa-rule.

Returns:DiscoveryServiceAssignmentType object
dump()

Display dsa-rule object in compact form.

get_fq_name()

Return FQN of dsa-rule in list form.

get_fq_name_str()

Return FQN of dsa-rule as colon delimited string.

get_parent_fq_name()

Return FQN of dsa-rule’s parent in list form.

get_parent_fq_name_str()

Return FQN of dsa-rule’s parent as colon delimted string.

get_type()

Return object type (dsa-rule).

id_perms

Get id-perms for dsa-rule.

Returns:IdPermsType object
perms2

Get perms2 for dsa-rule.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.FloatingIp(name=None, parent_obj=None, floating_ip_address=None, floating_ip_is_virtual_ip=None, floating_ip_fixed_ip_address=None, floating_ip_address_family=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents floating-ip configuration representation.

Child of:
FloatingIpPool object OR
Properties:
  • floating_ip_address

    Type: string, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CR

    Description:

    Floating ip address.

  • floating_ip_is_virtual_ip

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This floating ip is used as virtual ip (VIP) in case of LBaaS.

  • floating_ip_fixed_ip_address

    Type: string, one-of xsd:string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This floating is tracking given fixed ip of the interface. The given fixed ip is used in 1:1 NAT.

  • floating_ip_address_family

    Type: string, one-of [u’v4’, u’v6’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Ip address family of the floating ip, IpV4 or IpV6

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of Project objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Reference to project is which this floating ip was allocated.

  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to virtual machine interface to which this floating ip is attached.

Referred by:
add_project(ref_obj)

Add project to floating-ip.

Parameters:ref_obj – Project object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to floating-ip.

Parameters:ref_obj – VirtualMachineInterface object
display_name

Get display-name for floating-ip.

Returns:xsd:string object
dump()

Display floating-ip object in compact form.

floating_ip_address

Get floating-ip-address for floating-ip.

Returns:IpAddressType object
floating_ip_address_family

Get floating-ip-address-family for floating-ip.

Returns:IpAddressFamilyType object
floating_ip_fixed_ip_address

Get floating-ip-fixed-ip-address for floating-ip.

Returns:IpAddressType object
floating_ip_is_virtual_ip

Get floating-ip-is-virtual-ip for floating-ip.

Returns:xsd:boolean object
get_customer_attachment_back_refs()

Return list of all customer-attachments using this floating-ip

get_fq_name()

Return FQN of floating-ip in list form.

get_fq_name_str()

Return FQN of floating-ip as colon delimited string.

get_parent_fq_name()

Return FQN of floating-ip’s parent in list form.

get_parent_fq_name_str()

Return FQN of floating-ip’s parent as colon delimted string.

get_project_refs()

Return project list for floating-ip.

Returns:list of <Project>
get_type()

Return object type (floating-ip).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for floating-ip.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for floating-ip.

Returns:IdPermsType object
perms2

Get perms2 for floating-ip.

Returns:PermType2 object
set_project(ref_obj)

Set project for floating-ip.

Parameters:ref_obj – Project object
set_project_list(ref_obj_list)

Set project list for floating-ip.

Parameters:ref_obj_list – list of Project object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for floating-ip.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for floating-ip.

Parameters:ref_obj_list – list of VirtualMachineInterface object
class vnc_cfg_api_server.gen.resource_common.FloatingIpPool(name=None, parent_obj=None, floating_ip_pool_prefixes=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents floating-ip-pool configuration representation.

Child of:
VirtualNetwork object OR
Properties:
  • floating_ip_pool_prefixes

    Type: FloatingIpPoolType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of ip prefixes that restrict foating ip allocation from the corresponding virtual network.(Not

    yet implemented).

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of FloatingIp objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Floating ip is a ip that can be assigned to (virtual machine interface(VMI), ip), By doing so VMI

    can no be part of the floating ip network and floating ip is used as one:one to NAT for doing so.

References to:

Referred by:
display_name

Get display-name for floating-ip-pool.

Returns:xsd:string object
dump()

Display floating-ip-pool object in compact form.

floating_ip_pool_prefixes

Get floating-ip-pool-prefixes for floating-ip-pool.

Returns:FloatingIpPoolType object
get_fq_name()

Return FQN of floating-ip-pool in list form.

get_fq_name_str()

Return FQN of floating-ip-pool as colon delimited string.

get_parent_fq_name()

Return FQN of floating-ip-pool’s parent in list form.

get_parent_fq_name_str()

Return FQN of floating-ip-pool’s parent as colon delimted string.

get_project_back_refs()

Return list of all projects using this floating-ip-pool

get_type()

Return object type (floating-ip-pool).

id_perms

Get id-perms for floating-ip-pool.

Returns:IdPermsType object
perms2

Get perms2 for floating-ip-pool.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.ForwardingClass(name=None, parent_obj=None, forwarding_class_id=None, forwarding_class_dscp=None, forwarding_class_vlan_priority=None, forwarding_class_mpls_exp=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents forwarding-class configuration representation.

Child of:
GlobalQosConfig object OR
Properties:
  • forwarding_class_id

    Type: int

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Unique ID for this forwarding class.

  • forwarding_class_dscp

    Type: int

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    DSCP value to be written on outgoing packet for this forwarding-class.

  • forwarding_class_vlan_priority

    Type: int

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    802.1p value to be written on outgoing packet for this forwarding-class.

  • forwarding_class_mpls_exp

    Type: int

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    MPLS exp value to be written on outgoing packet for this forwarding-class.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of QosQueue objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Qos queue to be used for this forwarding class.

Referred by:

add_qos_queue(ref_obj)

Add qos-queue to forwarding-class.

Parameters:ref_obj – QosQueue object
display_name

Get display-name for forwarding-class.

Returns:xsd:string object
dump()

Display forwarding-class object in compact form.

forwarding_class_dscp

Get forwarding-class-dscp for forwarding-class.

Returns:xsd:integer object
forwarding_class_id

Get forwarding-class-id for forwarding-class.

Returns:xsd:integer object
forwarding_class_mpls_exp

Get forwarding-class-mpls-exp for forwarding-class.

Returns:xsd:integer object
forwarding_class_vlan_priority

Get forwarding-class-vlan-priority for forwarding-class.

Returns:xsd:integer object
get_fq_name()

Return FQN of forwarding-class in list form.

get_fq_name_str()

Return FQN of forwarding-class as colon delimited string.

get_parent_fq_name()

Return FQN of forwarding-class’s parent in list form.

get_parent_fq_name_str()

Return FQN of forwarding-class’s parent as colon delimted string.

get_qos_queue_refs()

Return qos-queue list for forwarding-class.

Returns:list of <QosQueue>
get_type()

Return object type (forwarding-class).

id_perms

Get id-perms for forwarding-class.

Returns:IdPermsType object
perms2

Get perms2 for forwarding-class.

Returns:PermType2 object
set_qos_queue(ref_obj)

Set qos-queue for forwarding-class.

Parameters:ref_obj – QosQueue object
set_qos_queue_list(ref_obj_list)

Set qos-queue list for forwarding-class.

Parameters:ref_obj_list – list of QosQueue object
class vnc_cfg_api_server.gen.resource_common.GlobalQosConfig(name=None, parent_obj=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents global-qos-config configuration representation.

Child of:
GlobalSystemConfig object OR
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of QosConfig objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Global system QoS config for vhost and fabric traffic .

  • list of ForwardingClass objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Link to global-qos config.

  • list of QosQueue objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    QOS queue config object in this project.

References to:

Referred by:

display_name

Get display-name for global-qos-config.

Returns:xsd:string object
dump()

Display global-qos-config object in compact form.

get_fq_name()

Return FQN of global-qos-config in list form.

get_fq_name_str()

Return FQN of global-qos-config as colon delimited string.

get_parent_fq_name()

Return FQN of global-qos-config’s parent in list form.

get_parent_fq_name_str()

Return FQN of global-qos-config’s parent as colon delimted string.

get_type()

Return object type (global-qos-config).

id_perms

Get id-perms for global-qos-config.

Returns:IdPermsType object
perms2

Get perms2 for global-qos-config.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.GlobalSystemConfig(name=None, parent_obj=None, autonomous_system=None, config_version=None, graceful_restart_params=None, plugin_tuning=None, ibgp_auto_mesh=None, ip_fabric_subnets=None, alarm_enable=None, user_defined_counter=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents global-system-config configuration representation.

Child of:
ConfigRoot object OR
Properties:
  • autonomous_system

    Type: int, within [1, 65534]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    16 bit BGP Autonomous System number for the cluster.

  • config_version

    Type: string

    Created By: System

    Operations Allowed: R

    Description:

    Version of OpenContrail software that generated this config.

  • graceful_restart_params

    Type: GracefulRestartType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Graceful Restart parameters

  • plugin_tuning

    Type: PluginProperties

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Various Orchestration system plugin(interface) parameters, like Openstack Neutron plugin.

  • ibgp_auto_mesh

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    When true, system will automatically create BGP peering mesh with all control-nodes that have same

    BGP AS number as global AS number.

  • ip_fabric_subnets

    Type: SubnetListType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of all subnets in which vrouter ip address exist. Used by Device manager to configure dynamic

    GRE tunnels on the SDN gateway.

  • alarm_enable

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Flag to enable/disable alarms configured under global-system-config. True, if not set.

  • user_defined_counter

    Type: UserDefinedCounterList

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    counter name and patterns

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of GlobalVrouterConfig objects

    Created By: User (required)

    Operations Allowed: R

    Description:

    Global vrouter config is object where all global vrouter config is present.

  • list of GlobalQosConfig objects

    Created By: User (required)

    Operations Allowed: R

    Description:

    Global QoS system config is object where all global system QoS configuration is present.

  • list of PhysicalRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Physical router object represent any physical device that participates in virtual networking, like

    routers, switches, servers, firewalls etc.

  • list of VirtualRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Virtual router is packet forwarding system on devices such as compute nodes(servers), TOR(s),

    routers.

  • list of ConfigNode objects

    Created By: User (admin-only)

    Operations Allowed: CRUD

    Description:

    Config node is object representing a logical node in system which serves config API.

  • list of AnalyticsNode objects

    Created By: User (admin-only)

    Operations Allowed: CRUD

    Description:

    Analytics node is object representing a logical node in system which serves operational API and

    analytics collector.

  • list of DatabaseNode objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Database node is object representing a logical node in system which host Cassendra DB and Zookeeper.

  • list of ServiceApplianceSet objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Service appliance set is the collection of service appliances.

    This collection is used as a provider in loadbalancer pool config.

    Algorithm to distribute/choose one appliance over other can be built while creating loadbalancer

    pool.

    By default, system will create service-appliance-set with name “opencontrail”.

    This is the default loadbalancer provider for pools in Contrail.

    This provider is based on “ha-proxy”.Service appliance set has following attribute -

    Driver to load for provisioning the appliance

    Service appliance properties - HA mode.

  • list of ApiAccessList objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Global API access list applicable to all domain and projects

  • list of Alarm objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of alarms that are applicable to objects anchored under global-system-config.

References to:
  • list of BgpRouter objects

    Created By: User (required)

    Operations Allowed: R

    Description:

    List of references to all bgp routers in systems.

Referred by:

add_bgp_router(ref_obj)

Add bgp-router to global-system-config.

Parameters:ref_obj – BgpRouter object
alarm_enable

Get alarm-enable for global-system-config.

Returns:xsd:boolean object
autonomous_system

Get autonomous-system for global-system-config.

Returns:AutonomousSystemType object
config_version

Get config-version for global-system-config.

Returns:xsd:string object
display_name

Get display-name for global-system-config.

Returns:xsd:string object
dump()

Display global-system-config object in compact form.

get_bgp_router_refs()

Return bgp-router list for global-system-config.

Returns:list of <BgpRouter>
get_fq_name()

Return FQN of global-system-config in list form.

get_fq_name_str()

Return FQN of global-system-config as colon delimited string.

get_parent_fq_name()

Return FQN of global-system-config’s parent in list form.

get_parent_fq_name_str()

Return FQN of global-system-config’s parent as colon delimted string.

get_type()

Return object type (global-system-config).

graceful_restart_params

Get graceful-restart-params for global-system-config.

Returns:GracefulRestartType object
ibgp_auto_mesh

Get ibgp-auto-mesh for global-system-config.

Returns:xsd:boolean object
id_perms

Get id-perms for global-system-config.

Returns:IdPermsType object
ip_fabric_subnets

Get ip-fabric-subnets for global-system-config.

Returns:SubnetListType object
perms2

Get perms2 for global-system-config.

Returns:PermType2 object
plugin_tuning

Get plugin-tuning for global-system-config.

Returns:PluginProperties object
set_bgp_router(ref_obj)

Set bgp-router for global-system-config.

Parameters:ref_obj – BgpRouter object
set_bgp_router_list(ref_obj_list)

Set bgp-router list for global-system-config.

Parameters:ref_obj_list – list of BgpRouter object
user_defined_counter

Get user-defined-counter for global-system-config.

Returns:UserDefinedCounterList object
class vnc_cfg_api_server.gen.resource_common.GlobalVrouterConfig(name=None, parent_obj=None, ecmp_hashing_include_fields=None, linklocal_services=None, encapsulation_priorities=None, vxlan_network_identifier_mode=None, flow_export_rate=None, flow_aging_timeout_list=None, forwarding_mode=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents global-vrouter-config configuration representation.

Child of:
GlobalSystemConfig object OR
Properties:
  • ecmp_hashing_include_fields

    Type: EcmpHashingIncludeFields

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    ECMP hashing config at global level.

  • linklocal_services

    Type: LinklocalServicesTypes

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Global services provided on link local subnet to the virtual machines.

  • encapsulation_priorities

    Type: EncapsulationPrioritiesType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Ordered list of enapsulations that vrouter will use in priority order.

  • vxlan_network_identifier_mode

    Type: string, one-of [u’configured’, u’automatic’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Method of allocation of VxLAN VNI(s). Set at provision time and cannot be changed.

    configured = VxLAN VNI is given by user when virtual network is configured.

    automatic = System will allocate VxLAN VNI automatically.

  • flow_export_rate

    Type: int

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Flow export rate is global config, rate at which each vrouter will sample and export flow records to

    analytics

  • flow_aging_timeout_list

    Type: FlowAgingTimeoutList

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Flow aging timeout per application (protocol, port) list.

  • forwarding_mode

    Type: string, one-of [u’l2_l3’, u’l2’, u’l3’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Packet forwarding mode for this system L2-only, L3-only OR L2-L3. L2-L3 is default.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

display_name

Get display-name for global-vrouter-config.

Returns:xsd:string object
dump()

Display global-vrouter-config object in compact form.

ecmp_hashing_include_fields

Get ecmp-hashing-include-fields for global-vrouter-config.

Returns:EcmpHashingIncludeFields object
encapsulation_priorities

Get encapsulation-priorities for global-vrouter-config.

Returns:EncapsulationPrioritiesType object
flow_aging_timeout_list

Get flow-aging-timeout-list for global-vrouter-config.

Returns:FlowAgingTimeoutList object
flow_export_rate

Get flow-export-rate for global-vrouter-config.

Returns:xsd:integer object
forwarding_mode

Get forwarding-mode for global-vrouter-config.

Returns:ForwardingModeType object
get_fq_name()

Return FQN of global-vrouter-config in list form.

get_fq_name_str()

Return FQN of global-vrouter-config as colon delimited string.

get_parent_fq_name()

Return FQN of global-vrouter-config’s parent in list form.

get_parent_fq_name_str()

Return FQN of global-vrouter-config’s parent as colon delimted string.

get_type()

Return object type (global-vrouter-config).

id_perms

Get id-perms for global-vrouter-config.

Returns:IdPermsType object
linklocal_services

Get linklocal-services for global-vrouter-config.

Returns:LinklocalServicesTypes object
perms2

Get perms2 for global-vrouter-config.

Returns:PermType2 object
vxlan_network_identifier_mode

Get vxlan-network-identifier-mode for global-vrouter-config.

Returns:VxlanNetworkIdentifierModeType object
class vnc_cfg_api_server.gen.resource_common.InstanceIp(name=None, instance_ip_address=None, instance_ip_family=None, instance_ip_mode=None, secondary_ip_tracking_ip=None, subnet_uuid=None, instance_ip_secondary=False, instance_ip_local_ip=False, service_instance_ip=False, service_health_check_ip=False, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents instance-ip configuration representation.

Properties:
  • instance_ip_address

    Type: string, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Ip address value for instance ip.

  • instance_ip_family

    Type: string, one-of [u’v4’, u’v6’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Ip address family for instance ip, IPv4(v4) or IPv6(v6).

  • instance_ip_mode

    Type: string, one-of [u’active-active’, u’active-standby’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Ip address HA mode in case this instance ip is used in more than one interface, active-Active or

    active-Standby.

  • secondary_ip_tracking_ip

    Type: SubnetType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    When this instance ip is secondary ip, it can track activeness of another ip.

  • subnet_uuid

    Type: string

    Created By: User (optional)

    Operations Allowed: CR

    Description:

    This instance ip was allocated from this Subnet(UUID).

  • instance_ip_secondary

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This instance ip is secondary ip of the interface.

  • instance_ip_local_ip

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This instance ip is local to compute and will not be exported to other nodes.

  • service_instance_ip

    Type: bool

    Created By: System

    Operations Allowed: CRUD

    Description:

    This instance ip is used as service chain next hop

  • service_health_check_ip

    Type: bool

    Created By: System

    Operations Allowed: CRUD

    Description:

    This instance ip is used as service health check source ip

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualNetwork objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Reference to virtual network of this instance ip.

  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to virtual machine interface to which this instance ip is attached.

  • list of PhysicalRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This instance ip is used as IRB address on the referenced physical router (e.g.MX), In case of OVSDB

    TOR usecase this address will be used as default gateway for Host behind the TOR.

Referred by:
add_physical_router(ref_obj)

Add physical-router to instance-ip.

Parameters:ref_obj – PhysicalRouter object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to instance-ip.

Parameters:ref_obj – VirtualMachineInterface object
add_virtual_network(ref_obj)

Add virtual-network to instance-ip.

Parameters:ref_obj – VirtualNetwork object
display_name

Get display-name for instance-ip.

Returns:xsd:string object
dump()

Display instance-ip object in compact form.

get_fq_name()

Return FQN of instance-ip in list form.

get_fq_name_str()

Return FQN of instance-ip as colon delimited string.

get_physical_router_refs()

Return physical-router list for instance-ip.

Returns:list of <PhysicalRouter>
get_service_instance_back_refs()

Return list of all service-instances using this instance-ip

get_type()

Return object type (instance-ip).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for instance-ip.

Returns:list of <VirtualMachineInterface>
get_virtual_network_refs()

Return virtual-network list for instance-ip.

Returns:list of <VirtualNetwork>
id_perms

Get id-perms for instance-ip.

Returns:IdPermsType object
instance_ip_address

Get instance-ip-address for instance-ip.

Returns:IpAddressType object
instance_ip_family

Get instance-ip-family for instance-ip.

Returns:IpAddressFamilyType object
instance_ip_local_ip

Get instance-ip-local-ip for instance-ip.

Returns:xsd:boolean object
instance_ip_mode

Get instance-ip-mode for instance-ip.

Returns:AddressMode object
instance_ip_secondary

Get instance-ip-secondary for instance-ip.

Returns:xsd:boolean object
perms2

Get perms2 for instance-ip.

Returns:PermType2 object
secondary_ip_tracking_ip

Get secondary-ip-tracking-ip for instance-ip.

Returns:SubnetType object
service_health_check_ip

Get service-health-check-ip for instance-ip.

Returns:xsd:boolean object
service_instance_ip

Get service-instance-ip for instance-ip.

Returns:xsd:boolean object
set_physical_router(ref_obj)

Set physical-router for instance-ip.

Parameters:ref_obj – PhysicalRouter object
set_physical_router_list(ref_obj_list)

Set physical-router list for instance-ip.

Parameters:ref_obj_list – list of PhysicalRouter object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for instance-ip.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for instance-ip.

Parameters:ref_obj_list – list of VirtualMachineInterface object
set_virtual_network(ref_obj)

Set virtual-network for instance-ip.

Parameters:ref_obj – VirtualNetwork object
set_virtual_network_list(ref_obj_list)

Set virtual-network list for instance-ip.

Parameters:ref_obj_list – list of VirtualNetwork object
subnet_uuid

Get subnet-uuid for instance-ip.

Returns:xsd:string object
class vnc_cfg_api_server.gen.resource_common.InterfaceRouteTable(name=None, parent_obj=None, interface_route_table_routes=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents interface-route-table configuration representation.

Child of:
Project object OR
Properties:
  • interface_route_table_routes

    Type: RouteTableType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Interface route table used same structure as route table, however the next hop field is irrelevent.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of (ServiceInstance object, ServiceInterfaceTag attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to interface route table attached to (service instance, interface), This is used to add

    interface static routes to service instance interface.

Referred by:
add_service_instance(ref_obj, ref_data)

Add service-instance to interface-route-table.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – ServiceInterfaceTag object
display_name

Get display-name for interface-route-table.

Returns:xsd:string object
dump()

Display interface-route-table object in compact form.

get_fq_name()

Return FQN of interface-route-table in list form.

get_fq_name_str()

Return FQN of interface-route-table as colon delimited string.

get_parent_fq_name()

Return FQN of interface-route-table’s parent in list form.

get_parent_fq_name_str()

Return FQN of interface-route-table’s parent as colon delimted string.

get_service_instance_refs()

Return service-instance list for interface-route-table.

Returns:list of tuple <ServiceInstance, ServiceInterfaceTag>
get_type()

Return object type (interface-route-table).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this interface-route-table

id_perms

Get id-perms for interface-route-table.

Returns:IdPermsType object
interface_route_table_routes

Get interface-route-table-routes for interface-route-table.

Returns:RouteTableType object
perms2

Get perms2 for interface-route-table.

Returns:PermType2 object
set_service_instance(ref_obj, ref_data)

Set service-instance for interface-route-table.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – ServiceInterfaceTag object
set_service_instance_list(ref_obj_list, ref_data_list)

Set service-instance list for interface-route-table.

Parameters:
  • ref_obj_list – list of ServiceInstance object
  • ref_data_list – list of ServiceInterfaceTag object
class vnc_cfg_api_server.gen.resource_common.Loadbalancer(name=None, parent_obj=None, loadbalancer_properties=None, loadbalancer_provider=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents loadbalancer configuration representation.

Child of:
Project object OR
Properties:
  • loadbalancer_properties

    Type: LoadbalancerType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Loadbalance configuration like admin state, VIP, VIP subnet etc.

  • loadbalancer_provider

    Type: string

    Created By: User (optional)

    Operations Allowed: CR

    Description:

    Provider field selects backend provider of the LBaaS, Cloudadmin could offere different levels of

    service like gold, silver, bronze. Provided by HA-proxy or various HW or SW appliances in the

    backend.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of ServiceInstance objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Reference to the service instance, created automatically by the system.

  • list of VirtualMachineInterface objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Reference to the virtual machine interface for VIP, created automatically by the system.

Referred by:
add_service_instance(ref_obj)

Add service-instance to loadbalancer.

Parameters:ref_obj – ServiceInstance object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to loadbalancer.

Parameters:ref_obj – VirtualMachineInterface object
display_name

Get display-name for loadbalancer.

Returns:xsd:string object
dump()

Display loadbalancer object in compact form.

get_fq_name()

Return FQN of loadbalancer in list form.

get_fq_name_str()

Return FQN of loadbalancer as colon delimited string.

get_loadbalancer_listener_back_refs()

Return list of all loadbalancer-listeners using this loadbalancer

get_parent_fq_name()

Return FQN of loadbalancer’s parent in list form.

get_parent_fq_name_str()

Return FQN of loadbalancer’s parent as colon delimted string.

get_service_instance_refs()

Return service-instance list for loadbalancer.

Returns:list of <ServiceInstance>
get_type()

Return object type (loadbalancer).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for loadbalancer.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for loadbalancer.

Returns:IdPermsType object
loadbalancer_properties

Get loadbalancer-properties for loadbalancer.

Returns:LoadbalancerType object
loadbalancer_provider

Get loadbalancer-provider for loadbalancer.

Returns:xsd:string object
perms2

Get perms2 for loadbalancer.

Returns:PermType2 object
set_service_instance(ref_obj)

Set service-instance for loadbalancer.

Parameters:ref_obj – ServiceInstance object
set_service_instance_list(ref_obj_list)

Set service-instance list for loadbalancer.

Parameters:ref_obj_list – list of ServiceInstance object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for loadbalancer.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for loadbalancer.

Parameters:ref_obj_list – list of VirtualMachineInterface object
class vnc_cfg_api_server.gen.resource_common.LoadbalancerHealthmonitor(name=None, parent_obj=None, loadbalancer_healthmonitor_properties=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents loadbalancer-healthmonitor configuration representation.

Child of:
Project object OR
Properties:
  • loadbalancer_healthmonitor_properties

    Type: LoadbalancerHealthmonitorType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Configuration parameters for health monitor like type, method, retries etc.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
display_name

Get display-name for loadbalancer-healthmonitor.

Returns:xsd:string object
dump()

Display loadbalancer-healthmonitor object in compact form.

get_fq_name()

Return FQN of loadbalancer-healthmonitor in list form.

get_fq_name_str()

Return FQN of loadbalancer-healthmonitor as colon delimited string.

get_loadbalancer_pool_back_refs()

Return list of all loadbalancer-pools using this loadbalancer-healthmonitor

get_parent_fq_name()

Return FQN of loadbalancer-healthmonitor’s parent in list form.

get_parent_fq_name_str()

Return FQN of loadbalancer-healthmonitor’s parent as colon delimted string.

get_type()

Return object type (loadbalancer-healthmonitor).

id_perms

Get id-perms for loadbalancer-healthmonitor.

Returns:IdPermsType object
loadbalancer_healthmonitor_properties

Get loadbalancer-healthmonitor-properties for loadbalancer-healthmonitor.

Returns:LoadbalancerHealthmonitorType object
perms2

Get perms2 for loadbalancer-healthmonitor.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.LoadbalancerListener(name=None, parent_obj=None, loadbalancer_listener_properties=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents loadbalancer-listener configuration representation.

Child of:
Project object OR
Properties:
  • loadbalancer_listener_properties

    Type: LoadbalancerListenerType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of Loadbalancer objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

Referred by:
add_loadbalancer(ref_obj)

Add loadbalancer to loadbalancer-listener.

Parameters:ref_obj – Loadbalancer object
display_name

Get display-name for loadbalancer-listener.

Returns:xsd:string object
dump()

Display loadbalancer-listener object in compact form.

get_fq_name()

Return FQN of loadbalancer-listener in list form.

get_fq_name_str()

Return FQN of loadbalancer-listener as colon delimited string.

get_loadbalancer_pool_back_refs()

Return list of all loadbalancer-pools using this loadbalancer-listener

get_loadbalancer_refs()

Return loadbalancer list for loadbalancer-listener.

Returns:list of <Loadbalancer>
get_parent_fq_name()

Return FQN of loadbalancer-listener’s parent in list form.

get_parent_fq_name_str()

Return FQN of loadbalancer-listener’s parent as colon delimted string.

get_type()

Return object type (loadbalancer-listener).

id_perms

Get id-perms for loadbalancer-listener.

Returns:IdPermsType object
loadbalancer_listener_properties

Get loadbalancer-listener-properties for loadbalancer-listener.

Returns:LoadbalancerListenerType object
perms2

Get perms2 for loadbalancer-listener.

Returns:PermType2 object
set_loadbalancer(ref_obj)

Set loadbalancer for loadbalancer-listener.

Parameters:ref_obj – Loadbalancer object
set_loadbalancer_list(ref_obj_list)

Set loadbalancer list for loadbalancer-listener.

Parameters:ref_obj_list – list of Loadbalancer object
class vnc_cfg_api_server.gen.resource_common.LoadbalancerMember(name=None, parent_obj=None, loadbalancer_member_properties=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents loadbalancer-member configuration representation.

Child of:
LoadbalancerPool object OR
Properties:
  • loadbalancer_member_properties

    Type: LoadbalancerMemberType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Member configuration like ip addres, destination port, weight etc.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

display_name

Get display-name for loadbalancer-member.

Returns:xsd:string object
dump()

Display loadbalancer-member object in compact form.

get_fq_name()

Return FQN of loadbalancer-member in list form.

get_fq_name_str()

Return FQN of loadbalancer-member as colon delimited string.

get_parent_fq_name()

Return FQN of loadbalancer-member’s parent in list form.

get_parent_fq_name_str()

Return FQN of loadbalancer-member’s parent as colon delimted string.

get_type()

Return object type (loadbalancer-member).

id_perms

Get id-perms for loadbalancer-member.

Returns:IdPermsType object
loadbalancer_member_properties

Get loadbalancer-member-properties for loadbalancer-member.

Returns:LoadbalancerMemberType object
perms2

Get perms2 for loadbalancer-member.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.LoadbalancerPool(name=None, parent_obj=None, loadbalancer_pool_properties=None, loadbalancer_pool_provider=None, loadbalancer_pool_custom_attributes=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents loadbalancer-pool configuration representation.

Child of:
Project object OR
Properties:
  • loadbalancer_pool_properties

    Type: LoadbalancerPoolType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Configuration for loabalancer pool like protocol, subnet, etc.

  • loadbalancer_pool_provider

    Type: string

    Created By: User (optional)

    Operations Allowed: CR

    Description:

    Provider field selects backend provider of the LBaaS, Cloudadmin could offere different levels of

    service like gold, silver, bronze. Provided by HA-proxy or various HW or SW appliances in the

    backend. Applicable to LBaaS V1

  • loadbalancer_pool_custom_attributes

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Custom loadbalancer config, opaque to the system. Specified as list of Key:Value pairs. Applicable

    to LBaaS V1.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of LoadbalancerMember objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Configuration object representing each member of load balancer pool.

References to:
  • list of ServiceInstance objects

    Created By: System

    Operations Allowed: CR

    Description:

    Reference to the service instance serving this pool, applicable to LBaaS V1.

  • list of VirtualMachineInterface objects

    Created By: System

    Operations Allowed: CR

    Description:

    Reference to the virtual machine interface reaching pool subnet, applicable to LBaaS V1.

  • list of LoadbalancerListener objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to loadbaancer listner served by this pool, applicabale to LBaaS V2.

  • list of ServiceApplianceSet objects

    Created By: System

    Operations Allowed: RReference to service-appliance-set where this loadbalancer-pool is hosted. Applicable to LBaaS V1.

    Description:

  • list of LoadbalancerHealthmonitor objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to loadbalancer healthmonitor that this pool uses.

Referred by:
add_loadbalancer_healthmonitor(ref_obj)

Add loadbalancer-healthmonitor to loadbalancer-pool.

Parameters:ref_obj – LoadbalancerHealthmonitor object
add_loadbalancer_listener(ref_obj)

Add loadbalancer-listener to loadbalancer-pool.

Parameters:ref_obj – LoadbalancerListener object
add_service_appliance_set(ref_obj)

Add service-appliance-set to loadbalancer-pool.

Parameters:ref_obj – ServiceApplianceSet object
add_service_instance(ref_obj)

Add service-instance to loadbalancer-pool.

Parameters:ref_obj – ServiceInstance object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to loadbalancer-pool.

Parameters:ref_obj – VirtualMachineInterface object
display_name

Get display-name for loadbalancer-pool.

Returns:xsd:string object
dump()

Display loadbalancer-pool object in compact form.

get_fq_name()

Return FQN of loadbalancer-pool in list form.

get_fq_name_str()

Return FQN of loadbalancer-pool as colon delimited string.

get_loadbalancer_healthmonitor_refs()

Return loadbalancer-healthmonitor list for loadbalancer-pool.

Returns:list of <LoadbalancerHealthmonitor>
get_loadbalancer_listener_refs()

Return loadbalancer-listener list for loadbalancer-pool.

Returns:list of <LoadbalancerListener>
get_parent_fq_name()

Return FQN of loadbalancer-pool’s parent in list form.

get_parent_fq_name_str()

Return FQN of loadbalancer-pool’s parent as colon delimted string.

get_service_appliance_set_refs()

Return service-appliance-set list for loadbalancer-pool.

Returns:list of <ServiceApplianceSet>
get_service_instance_refs()

Return service-instance list for loadbalancer-pool.

Returns:list of <ServiceInstance>
get_type()

Return object type (loadbalancer-pool).

get_virtual_ip_back_refs()

Return list of all virtual-ips using this loadbalancer-pool

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for loadbalancer-pool.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for loadbalancer-pool.

Returns:IdPermsType object
loadbalancer_pool_custom_attributes

Get loadbalancer-pool-custom-attributes for loadbalancer-pool.

Returns:KeyValuePairs object
loadbalancer_pool_properties

Get loadbalancer-pool-properties for loadbalancer-pool.

Returns:LoadbalancerPoolType object
loadbalancer_pool_provider

Get loadbalancer-pool-provider for loadbalancer-pool.

Returns:xsd:string object
perms2

Get perms2 for loadbalancer-pool.

Returns:PermType2 object
set_loadbalancer_healthmonitor(ref_obj)

Set loadbalancer-healthmonitor for loadbalancer-pool.

Parameters:ref_obj – LoadbalancerHealthmonitor object
set_loadbalancer_healthmonitor_list(ref_obj_list)

Set loadbalancer-healthmonitor list for loadbalancer-pool.

Parameters:ref_obj_list – list of LoadbalancerHealthmonitor object
set_loadbalancer_listener(ref_obj)

Set loadbalancer-listener for loadbalancer-pool.

Parameters:ref_obj – LoadbalancerListener object
set_loadbalancer_listener_list(ref_obj_list)

Set loadbalancer-listener list for loadbalancer-pool.

Parameters:ref_obj_list – list of LoadbalancerListener object
set_service_appliance_set(ref_obj)

Set service-appliance-set for loadbalancer-pool.

Parameters:ref_obj – ServiceApplianceSet object
set_service_appliance_set_list(ref_obj_list)

Set service-appliance-set list for loadbalancer-pool.

Parameters:ref_obj_list – list of ServiceApplianceSet object
set_service_instance(ref_obj)

Set service-instance for loadbalancer-pool.

Parameters:ref_obj – ServiceInstance object
set_service_instance_list(ref_obj_list)

Set service-instance list for loadbalancer-pool.

Parameters:ref_obj_list – list of ServiceInstance object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for loadbalancer-pool.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for loadbalancer-pool.

Parameters:ref_obj_list – list of VirtualMachineInterface object
class vnc_cfg_api_server.gen.resource_common.LogicalInterface(name=None, parent_obj=None, logical_interface_vlan_tag=None, logical_interface_type=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents logical-interface configuration representation.

Child of:
PhysicalRouter object OR PhysicalInterface object OR
Properties:
  • logical_interface_vlan_tag

    Type: int

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    VLAN tag (.1Q) classifier for this logical interface.

  • logical_interface_type

    Type: string, one-of [u’l2’, u’l3’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Logical interface type can be L2 or L3.

    L2 - only L2 service is provided, MAC learning is supported.

    L3 - only L3 service is supported and MAC learning is not supported.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    References to virtual machine interfaces that represent end points that are reacheable by this

    logical interface.

Referred by:

add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to logical-interface.

Parameters:ref_obj – VirtualMachineInterface object
display_name

Get display-name for logical-interface.

Returns:xsd:string object
dump()

Display logical-interface object in compact form.

get_fq_name()

Return FQN of logical-interface in list form.

get_fq_name_str()

Return FQN of logical-interface as colon delimited string.

get_parent_fq_name()

Return FQN of logical-interface’s parent in list form.

get_parent_fq_name_str()

Return FQN of logical-interface’s parent as colon delimted string.

get_type()

Return object type (logical-interface).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for logical-interface.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for logical-interface.

Returns:IdPermsType object
logical_interface_type

Get logical-interface-type for logical-interface.

Returns:LogicalInterfaceType object
logical_interface_vlan_tag

Get logical-interface-vlan-tag for logical-interface.

Returns:xsd:integer object
perms2

Get perms2 for logical-interface.

Returns:PermType2 object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for logical-interface.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for logical-interface.

Parameters:ref_obj_list – list of VirtualMachineInterface object
class vnc_cfg_api_server.gen.resource_common.LogicalRouter(name=None, parent_obj=None, configured_route_target_list=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents logical-router configuration representation.

Child of:
Project object OR
Properties:
  • configured_route_target_list

    Type: RouteTargetList

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of route targets that represent this logical router, all virtual networks connected to this

    logical router will have this as their route target list.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Refernce to the interface attached to this logical router. By attaching a interface to logical

    network all subnets in the virtual network of the interface has this router.

  • list of RouteTarget objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Route target that represent this logical router.

  • list of RouteTable objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to the route table attached to this logical router. By attaching route table, system will

    create static routes with the route target only of route targets linked to this logical router

  • list of VirtualNetwork objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Refernce to virtual network used as external gateway for this logical network. This link will cause

    a SNAT being spwaned between all networks connected to logical router and external network.

  • list of ServiceInstance objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Refernce to service instance doing SNAT functionality for external gateway.

Referred by:

add_route_table(ref_obj)

Add route-table to logical-router.

Parameters:ref_obj – RouteTable object
add_route_target(ref_obj)

Add route-target to logical-router.

Parameters:ref_obj – RouteTarget object
add_service_instance(ref_obj)

Add service-instance to logical-router.

Parameters:ref_obj – ServiceInstance object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to logical-router.

Parameters:ref_obj – VirtualMachineInterface object
add_virtual_network(ref_obj)

Add virtual-network to logical-router.

Parameters:ref_obj – VirtualNetwork object
configured_route_target_list

Get configured-route-target-list for logical-router.

Returns:RouteTargetList object
display_name

Get display-name for logical-router.

Returns:xsd:string object
dump()

Display logical-router object in compact form.

get_fq_name()

Return FQN of logical-router in list form.

get_fq_name_str()

Return FQN of logical-router as colon delimited string.

get_parent_fq_name()

Return FQN of logical-router’s parent in list form.

get_parent_fq_name_str()

Return FQN of logical-router’s parent as colon delimted string.

get_route_table_refs()

Return route-table list for logical-router.

Returns:list of <RouteTable>
get_route_target_refs()

Return route-target list for logical-router.

Returns:list of <RouteTarget>
get_service_instance_refs()

Return service-instance list for logical-router.

Returns:list of <ServiceInstance>
get_type()

Return object type (logical-router).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for logical-router.

Returns:list of <VirtualMachineInterface>
get_virtual_network_refs()

Return virtual-network list for logical-router.

Returns:list of <VirtualNetwork>
id_perms

Get id-perms for logical-router.

Returns:IdPermsType object
perms2

Get perms2 for logical-router.

Returns:PermType2 object
set_route_table(ref_obj)

Set route-table for logical-router.

Parameters:ref_obj – RouteTable object
set_route_table_list(ref_obj_list)

Set route-table list for logical-router.

Parameters:ref_obj_list – list of RouteTable object
set_route_target(ref_obj)

Set route-target for logical-router.

Parameters:ref_obj – RouteTarget object
set_route_target_list(ref_obj_list)

Set route-target list for logical-router.

Parameters:ref_obj_list – list of RouteTarget object
set_service_instance(ref_obj)

Set service-instance for logical-router.

Parameters:ref_obj – ServiceInstance object
set_service_instance_list(ref_obj_list)

Set service-instance list for logical-router.

Parameters:ref_obj_list – list of ServiceInstance object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for logical-router.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for logical-router.

Parameters:ref_obj_list – list of VirtualMachineInterface object
set_virtual_network(ref_obj)

Set virtual-network for logical-router.

Parameters:ref_obj – VirtualNetwork object
set_virtual_network_list(ref_obj_list)

Set virtual-network list for logical-router.

Parameters:ref_obj_list – list of VirtualNetwork object
class vnc_cfg_api_server.gen.resource_common.Namespace(name=None, parent_obj=None, namespace_cidr=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents namespace configuration representation.

Child of:
Domain object OR
Properties:
  • namespace_cidr

    Type: SubnetType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    All networks in this namespace belong to this list of Prefixes. Not implemented.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
display_name

Get display-name for namespace.

Returns:xsd:string object
dump()

Display namespace object in compact form.

get_fq_name()

Return FQN of namespace in list form.

get_fq_name_str()

Return FQN of namespace as colon delimited string.

get_parent_fq_name()

Return FQN of namespace’s parent in list form.

get_parent_fq_name_str()

Return FQN of namespace’s parent as colon delimted string.

get_project_back_refs()

Return list of all projects using this namespace

get_type()

Return object type (namespace).

id_perms

Get id-perms for namespace.

Returns:IdPermsType object
namespace_cidr

Get namespace-cidr for namespace.

Returns:SubnetType object
perms2

Get perms2 for namespace.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.NetworkIpam(name=None, parent_obj=None, network_ipam_mgmt=None, ipam_subnets=None, ipam_subnet_method=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents network-ipam configuration representation.

Child of:
Project object OR
Properties:
  • network_ipam_mgmt

    Type: IpamType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Network IP Address Management configuration.

  • ipam_subnets

    Type: IpamSubnets

    Created By: User (optional)

    Operations Allowed: CRD

    Description:

    List of subnets for this ipam.

  • ipam_subnet_method

    Type: string, one-of [u’user-defined-subnet’, u’flat-subnet’, u’auto-subnet’]

    Created By: User (optional)

    Operations Allowed: CRD

    Description:

    Subnet method configuration for ipam, user can configure user-defined, flat or auto.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualDns objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to virtual DNS used by this IPAM.

Referred by:
add_virtual_DNS(ref_obj)

Add virtual-DNS to network-ipam.

Parameters:ref_obj – VirtualDns object
display_name

Get display-name for network-ipam.

Returns:xsd:string object
dump()

Display network-ipam object in compact form.

get_fq_name()

Return FQN of network-ipam in list form.

get_fq_name_str()

Return FQN of network-ipam as colon delimited string.

get_parent_fq_name()

Return FQN of network-ipam’s parent in list form.

get_parent_fq_name_str()

Return FQN of network-ipam’s parent as colon delimted string.

get_type()

Return object type (network-ipam).

get_virtual_DNS_refs()

Return virtual-DNS list for network-ipam.

Returns:list of <VirtualDns>
get_virtual_network_back_refs()

Return list of all virtual-networks using this network-ipam

id_perms

Get id-perms for network-ipam.

Returns:IdPermsType object
ipam_subnet_method

Get ipam-subnet-method for network-ipam.

Returns:SubnetMethodType object
ipam_subnets

Get ipam-subnets for network-ipam.

Returns:IpamSubnets object
network_ipam_mgmt

Get network-ipam-mgmt for network-ipam.

Returns:IpamType object
perms2

Get perms2 for network-ipam.

Returns:PermType2 object
set_virtual_DNS(ref_obj)

Set virtual-DNS for network-ipam.

Parameters:ref_obj – VirtualDns object
set_virtual_DNS_list(ref_obj_list)

Set virtual-DNS list for network-ipam.

Parameters:ref_obj_list – list of VirtualDns object
class vnc_cfg_api_server.gen.resource_common.NetworkPolicy(name=None, parent_obj=None, network_policy_entries=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents network-policy configuration representation.

Child of:
Project object OR
Properties:
  • network_policy_entries

    Type: PolicyEntriesType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Network policy rule entries.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
display_name

Get display-name for network-policy.

Returns:xsd:string object
dump()

Display network-policy object in compact form.

get_fq_name()

Return FQN of network-policy in list form.

get_fq_name_str()

Return FQN of network-policy as colon delimited string.

get_parent_fq_name()

Return FQN of network-policy’s parent in list form.

get_parent_fq_name_str()

Return FQN of network-policy’s parent as colon delimted string.

get_type()

Return object type (network-policy).

get_virtual_network_back_refs()

Return list of all virtual-networks using this network-policy

id_perms

Get id-perms for network-policy.

Returns:IdPermsType object
network_policy_entries

Get network-policy-entries for network-policy.

Returns:PolicyEntriesType object
perms2

Get perms2 for network-policy.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.PhysicalInterface(name=None, parent_obj=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents physical-interface configuration representation.

Child of:
PhysicalRouter object OR
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of LogicalInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Logical interfaces on physical interface on physical routers.

References to:
  • list of PhysicalInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to the other physical interface that is connected to this physical interface.

Referred by:
add_physical_interface(ref_obj)

Add physical-interface to physical-interface.

Parameters:ref_obj – PhysicalInterface object
display_name

Get display-name for physical-interface.

Returns:xsd:string object
dump()

Display physical-interface object in compact form.

get_fq_name()

Return FQN of physical-interface in list form.

get_fq_name_str()

Return FQN of physical-interface as colon delimited string.

get_parent_fq_name()

Return FQN of physical-interface’s parent in list form.

get_parent_fq_name_str()

Return FQN of physical-interface’s parent as colon delimted string.

get_physical_interface_back_refs()

Return list of all physical-interfaces using this physical-interface

get_physical_interface_refs()

Return physical-interface list for physical-interface.

Returns:list of <PhysicalInterface>
get_service_appliance_back_refs()

Return list of all service-appliances using this physical-interface

get_type()

Return object type (physical-interface).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this physical-interface

id_perms

Get id-perms for physical-interface.

Returns:IdPermsType object
perms2

Get perms2 for physical-interface.

Returns:PermType2 object
set_physical_interface(ref_obj)

Set physical-interface for physical-interface.

Parameters:ref_obj – PhysicalInterface object
set_physical_interface_list(ref_obj_list)

Set physical-interface list for physical-interface.

Parameters:ref_obj_list – list of PhysicalInterface object
class vnc_cfg_api_server.gen.resource_common.PhysicalRouter(name=None, parent_obj=None, physical_router_management_ip=None, physical_router_dataplane_ip=None, physical_router_vendor_name=None, physical_router_product_name=None, physical_router_vnc_managed=None, physical_router_user_credentials=None, physical_router_snmp_credentials=None, physical_router_junos_service_ports=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents physical-router configuration representation.

Child of:
GlobalSystemConfig object OR
Properties:
  • physical_router_management_ip

    Type: string, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Management ip for this physical router. It is used by the device manager to perform netconf and by

    SNMP collector if enabled.

  • physical_router_dataplane_ip

    Type: string, one-of xsd:string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This is ip address in the ip-fabric(underlay) network that can be used in data palne by physical

    router. Usually it is the VTEP address in VxLAN for the TOR switch.

  • physical_router_vendor_name

    Type: string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Vendor name of the physical router (e.g juniper). Used by the device manager to select driver.

  • physical_router_product_name

    Type: string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Model name of the physical router (e.g juniper). Used by the device manager to select driver.

  • physical_router_vnc_managed

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This physical router is enabled to be configured by device manager.

  • physical_router_user_credentials

    Type: UserCredentials

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Username and password for netconf to the physical router by device manager.

  • physical_router_snmp_credentials

    Type: SNMPCredentials

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    SNMP credentials for the physical router used by SNMP colloctor.

  • physical_router_junos_service_ports

    Type: JunosServicePorts

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Juniper JUNOS specific sevice interfaces name to perform services like NAT.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of PhysicalInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Physical interfaces on physical routers.

  • list of LogicalInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Logical interfaces on physical routers.

References to:
  • list of VirtualRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Referance to vrouter responsible for this physical router. Currently only pplicable for vrouters

    that are TOR agents.

  • list of BgpRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Referance to BGP peer representing this physical router.

  • list of VirtualNetwork objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to virtual network, whose VRF is present on this physical router, Applicable when only VRF

    is present with no physical interfaces from this physical vrouter. Generally used when using device

    manager and option A+B for this virtual network in L3VPN use case.

Referred by:
add_bgp_router(ref_obj)

Add bgp-router to physical-router.

Parameters:ref_obj – BgpRouter object
add_virtual_network(ref_obj)

Add virtual-network to physical-router.

Parameters:ref_obj – VirtualNetwork object
add_virtual_router(ref_obj)

Add virtual-router to physical-router.

Parameters:ref_obj – VirtualRouter object
display_name

Get display-name for physical-router.

Returns:xsd:string object
dump()

Display physical-router object in compact form.

get_bgp_router_refs()

Return bgp-router list for physical-router.

Returns:list of <BgpRouter>
get_fq_name()

Return FQN of physical-router in list form.

get_fq_name_str()

Return FQN of physical-router as colon delimited string.

get_instance_ip_back_refs()

Return list of all instance-ips using this physical-router

get_parent_fq_name()

Return FQN of physical-router’s parent in list form.

get_parent_fq_name_str()

Return FQN of physical-router’s parent as colon delimted string.

get_type()

Return object type (physical-router).

get_virtual_network_refs()

Return virtual-network list for physical-router.

Returns:list of <VirtualNetwork>
get_virtual_router_refs()

Return virtual-router list for physical-router.

Returns:list of <VirtualRouter>
id_perms

Get id-perms for physical-router.

Returns:IdPermsType object
perms2

Get perms2 for physical-router.

Returns:PermType2 object
physical_router_dataplane_ip

Get physical-router-dataplane-ip for physical-router.

Returns:IpAddress object
physical_router_junos_service_ports

Get physical-router-junos-service-ports for physical-router.

Returns:JunosServicePorts object
physical_router_management_ip

Get physical-router-management-ip for physical-router.

Returns:IpAddress object
physical_router_product_name

Get physical-router-product-name for physical-router.

Returns:xsd:string object
physical_router_snmp_credentials

Get physical-router-snmp-credentials for physical-router.

Returns:SNMPCredentials object
physical_router_user_credentials

Get physical-router-user-credentials for physical-router.

Returns:UserCredentials object
physical_router_vendor_name

Get physical-router-vendor-name for physical-router.

Returns:xsd:string object
physical_router_vnc_managed

Get physical-router-vnc-managed for physical-router.

Returns:xsd:boolean object
set_bgp_router(ref_obj)

Set bgp-router for physical-router.

Parameters:ref_obj – BgpRouter object
set_bgp_router_list(ref_obj_list)

Set bgp-router list for physical-router.

Parameters:ref_obj_list – list of BgpRouter object
set_virtual_network(ref_obj)

Set virtual-network for physical-router.

Parameters:ref_obj – VirtualNetwork object
set_virtual_network_list(ref_obj_list)

Set virtual-network list for physical-router.

Parameters:ref_obj_list – list of VirtualNetwork object
set_virtual_router(ref_obj)

Set virtual-router for physical-router.

Parameters:ref_obj – VirtualRouter object
set_virtual_router_list(ref_obj_list)

Set virtual-router list for physical-router.

Parameters:ref_obj_list – list of VirtualRouter object
class vnc_cfg_api_server.gen.resource_common.PortTuple(name=None, parent_obj=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents port-tuple configuration representation.

Child of:
ServiceInstance object OR
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
display_name

Get display-name for port-tuple.

Returns:xsd:string object
dump()

Display port-tuple object in compact form.

get_fq_name()

Return FQN of port-tuple in list form.

get_fq_name_str()

Return FQN of port-tuple as colon delimited string.

get_parent_fq_name()

Return FQN of port-tuple’s parent in list form.

get_parent_fq_name_str()

Return FQN of port-tuple’s parent as colon delimted string.

get_type()

Return object type (port-tuple).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this port-tuple

id_perms

Get id-perms for port-tuple.

Returns:IdPermsType object
perms2

Get perms2 for port-tuple.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.Project(name=None, parent_obj=None, quota=None, alarm_enable=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents project configuration representation.

Child of:
Domain object OR
Properties:
  • quota

    Type: QuotaType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Max instances limits for various objects under project.

  • alarm_enable

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Flag to enable/disable alarms configured under global-system-config. True, if not set.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of SecurityGroup objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Security Groups are set of state full access control rules attached to interfaces.It can be used to

    implement microsegmentation.

  • list of VirtualNetwork objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Virtual network is collection of end points (interface or ip(s) or MAC(s)) that can talk to each

    other by default. It is collection of subnets connected by implicit router which default gateway in

    each subnet.

  • list of QosConfig objects

    Created By: User (optional)

    Operations Allowed: CRUDQOS configuration specifying marking and queueing value for various QoS values

    Description:

  • list of NetworkIpam objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    IP Address Management object that controls, ip allocation, DNS and DHCP

  • list of NetworkPolicy objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Network Policy is set access control rules that can be attached to virtual networks. Network ACL(s)

    and connectivity information is derived from Network policies that are attached to virtual networks.

  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Virtual machine interface represent a interface(port) into virtual network. It may or may not have

    corresponding virtual machine. A virtual machine interface has atleast a MAC address and Ip address.

  • list of BgpAsAService objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    BGP as service object represents BGP peer in the virtual network that can participate in dynamic

    routing with implicit default gateway of the virtual network.

  • list of RoutingPolicy objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of references of child routing policy objects. automatically maintained by system.

  • list of RouteAggregate objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of references of child routing route aggregate objects. automatically maintained by system.

  • list of ServiceInstance objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Service instance represents logical instance service used in the virtual world, e.g. firewall, load

    balancer etc. It can represent one or multiple virtual machines or physical devices. Many service

    instances can share a virtual machine or physical device.

  • list of ServiceHealthCheck objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Service health check is a keepalive machenism for the virtual machine interface. Liveliness of the

    interface is determined based on configuration in the service health check. It is mainly designed

    for service instance interfaces. However it will work with any interface which present on contrail

    vrouter.

  • list of RouteTable objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Network route table is machinism of adding static routes in the virtual network

  • list of InterfaceRouteTable objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Interface route table is machanism to add static routes pointing to this interface.

  • list of LogicalRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Logical router is a machanism to connect multiple virtual network as they have been connected by a

    router.

  • list of ApiAccessList objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    API access list is list of rules that define role based access to each API and its properties at

    project level.

  • list of LoadbalancerPool objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Loadbalancer pool object represent set(pool) memeber servers which needs load balancing.

  • list of LoadbalancerHealthmonitor objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Health monitor objects is configuration to monitor health of individual pool members.

  • list of VirtualIp objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Virtual ip opject application(protocol, port). Applicable only to LBaaS V1

  • list of LoadbalancerListener objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Listener represents the application(protocol, port) to be load balanced.

  • list of Loadbalancer objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Loadbalancer object represents a LBaaS instance. One single Virtual IP and multiple (listeners,

    pools). Applicable to LBaaS V2.

  • list of Alarm objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of alarms that are applicable to objects anchored under the project.

References to:
  • list of (Namespace object, SubnetType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to network namespace of this project.

  • list of FloatingIpPool objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to floating ip pool in this project.

  • list of AliasIpPool objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to alias ip pool in this project.

Referred by:
add_alias_ip_pool(ref_obj)

Add alias-ip-pool to project.

Parameters:ref_obj – AliasIpPool object
add_floating_ip_pool(ref_obj)

Add floating-ip-pool to project.

Parameters:ref_obj – FloatingIpPool object
add_namespace(ref_obj, ref_data)

Add namespace to project.

Parameters:
  • ref_obj – Namespace object
  • ref_data – SubnetType object
alarm_enable

Get alarm-enable for project.

Returns:xsd:boolean object
display_name

Get display-name for project.

Returns:xsd:string object
dump()

Display project object in compact form.

get_alias_ip_back_refs()

Return list of all alias-ips using this project

get_alias_ip_pool_refs()

Return alias-ip-pool list for project.

Returns:list of <AliasIpPool>
get_floating_ip_back_refs()

Return list of all floating-ips using this project

get_floating_ip_pool_refs()

Return floating-ip-pool list for project.

Returns:list of <FloatingIpPool>
get_fq_name()

Return FQN of project in list form.

get_fq_name_str()

Return FQN of project as colon delimited string.

get_namespace_refs()

Return namespace list for project.

Returns:list of tuple <Namespace, SubnetType>
get_parent_fq_name()

Return FQN of project’s parent in list form.

get_parent_fq_name_str()

Return FQN of project’s parent as colon delimted string.

get_type()

Return object type (project).

id_perms

Get id-perms for project.

Returns:IdPermsType object
perms2

Get perms2 for project.

Returns:PermType2 object
quota

Get quota for project.

Returns:QuotaType object
set_alias_ip_pool(ref_obj)

Set alias-ip-pool for project.

Parameters:ref_obj – AliasIpPool object
set_alias_ip_pool_list(ref_obj_list)

Set alias-ip-pool list for project.

Parameters:ref_obj_list – list of AliasIpPool object
set_floating_ip_pool(ref_obj)

Set floating-ip-pool for project.

Parameters:ref_obj – FloatingIpPool object
set_floating_ip_pool_list(ref_obj_list)

Set floating-ip-pool list for project.

Parameters:ref_obj_list – list of FloatingIpPool object
set_namespace(ref_obj, ref_data)

Set namespace for project.

Parameters:
  • ref_obj – Namespace object
  • ref_data – SubnetType object
set_namespace_list(ref_obj_list, ref_data_list)

Set namespace list for project.

Parameters:
  • ref_obj_list – list of Namespace object
  • ref_data_list – list of SubnetType object
class vnc_cfg_api_server.gen.resource_common.ProviderAttachment(name=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents provider-attachment configuration representation.

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Not in Use.

Referred by:

add_virtual_router(ref_obj)

Add virtual-router to provider-attachment.

Parameters:ref_obj – VirtualRouter object
display_name

Get display-name for provider-attachment.

Returns:xsd:string object
dump()

Display provider-attachment object in compact form.

get_fq_name()

Return FQN of provider-attachment in list form.

get_fq_name_str()

Return FQN of provider-attachment as colon delimited string.

get_type()

Return object type (provider-attachment).

get_virtual_router_refs()

Return virtual-router list for provider-attachment.

Returns:list of <VirtualRouter>
id_perms

Get id-perms for provider-attachment.

Returns:IdPermsType object
perms2

Get perms2 for provider-attachment.

Returns:PermType2 object
set_virtual_router(ref_obj)

Set virtual-router for provider-attachment.

Parameters:ref_obj – VirtualRouter object
set_virtual_router_list(ref_obj_list)

Set virtual-router list for provider-attachment.

Parameters:ref_obj_list – list of VirtualRouter object
class vnc_cfg_api_server.gen.resource_common.QosConfig(name=None, parent_obj=None, qos_config_type=None, dscp_entries=None, vlan_priority_entries=None, mpls_exp_entries=None, default_forwarding_class_id=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents qos-config configuration representation.

Child of:
GlobalQosConfig object OR Project object OR
Properties:
  • qos_config_type

    Type: string, one-of [u’vhost’, u’fabric’, u’project’]

    Created By: User (CRUD)

    Operations Allowed: SPECIFIES IF QOS-CONFIG IS FOR VHOST, FABRIC OR FOR PROJECT.

    Description:

  • dscp_entries

    Type: QosIdForwardingClassPairs

    Created By: User (CRUD)

    Operations Allowed: MAP OF DSCP MATCH CONDITION AND APPLICABLE FORWARDING CLASS FOR PACKET.

    Description:

  • vlan_priority_entries

    Type: QosIdForwardingClassPairs

    Created By: User (CRUD)

    Operations Allowed: MAP OF .1P PRIORITY CODE TO APPLICABLE FORWARDING CLASS FOR PACKET.

    Description:

  • mpls_exp_entries

    Type: QosIdForwardingClassPairs

    Created By: User (CRUD)

    Operations Allowed: MAP OF MPLS EXP VALUES TO APPLICABLE FORWARDING CLASS FOR PACKET.

    Description:

  • default_forwarding_class_id

    Type: int

    Created By: User (CRUD)

    Operations Allowed: DEFAULT FORWARDING CLASS USED FOR ALL NON-SPECIFIED QOS BITS

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
default_forwarding_class_id

Get default-forwarding-class-id for qos-config.

Returns:xsd:integer object
display_name

Get display-name for qos-config.

Returns:xsd:string object
dscp_entries

Get dscp-entries for qos-config.

Returns:QosIdForwardingClassPairs object
dump()

Display qos-config object in compact form.

get_fq_name()

Return FQN of qos-config in list form.

get_fq_name_str()

Return FQN of qos-config as colon delimited string.

get_parent_fq_name()

Return FQN of qos-config’s parent in list form.

get_parent_fq_name_str()

Return FQN of qos-config’s parent as colon delimted string.

get_type()

Return object type (qos-config).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this qos-config

get_virtual_network_back_refs()

Return list of all virtual-networks using this qos-config

id_perms

Get id-perms for qos-config.

Returns:IdPermsType object
mpls_exp_entries

Get mpls-exp-entries for qos-config.

Returns:QosIdForwardingClassPairs object
perms2

Get perms2 for qos-config.

Returns:PermType2 object
qos_config_type

Get qos-config-type for qos-config.

Returns:QosConfigType object
vlan_priority_entries

Get vlan-priority-entries for qos-config.

Returns:QosIdForwardingClassPairs object
class vnc_cfg_api_server.gen.resource_common.QosQueue(name=None, parent_obj=None, min_bandwidth=None, max_bandwidth=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents qos-queue configuration representation.

Child of:
GlobalQosConfig object OR
Properties:
  • min_bandwidth

    Type: int

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Minimum bandwidth for this queue.

  • max_bandwidth

    Type: int

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Maximum bandwidth for this queue.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
display_name

Get display-name for qos-queue.

Returns:xsd:string object
dump()

Display qos-queue object in compact form.

get_forwarding_class_back_refs()

Return list of all forwarding-classs using this qos-queue

get_fq_name()

Return FQN of qos-queue in list form.

get_fq_name_str()

Return FQN of qos-queue as colon delimited string.

get_parent_fq_name()

Return FQN of qos-queue’s parent in list form.

get_parent_fq_name_str()

Return FQN of qos-queue’s parent as colon delimted string.

get_type()

Return object type (qos-queue).

id_perms

Get id-perms for qos-queue.

Returns:IdPermsType object
max_bandwidth

Get max-bandwidth for qos-queue.

Returns:xsd:integer object
min_bandwidth

Get min-bandwidth for qos-queue.

Returns:xsd:integer object
perms2

Get perms2 for qos-queue.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.RouteAggregate(name=None, parent_obj=None, aggregate_route_entries=None, aggregate_route_nexthop=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents route-aggregate configuration representation.

Child of:
Project object OR
Properties:
  • aggregate_route_entries

    Type: RouteListType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    List of ip prefix (aggregate route prefix) for which aggregate route will be advertised. This

    aggregate route is advertised if a matching(longest prefix match) prefix is found.

  • aggregate_route_nexthop

    Type: string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Next for aggregate route that will be advertised.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of (ServiceInstance object, ServiceInterfaceTag attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to route-aggregate policy attached to (service instance, interface).

  • list of RoutingInstance objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Reference to internal routing instance object automatically generated by system.

Referred by:

add_routing_instance(ref_obj)

Add routing-instance to route-aggregate.

Parameters:ref_obj – RoutingInstance object
add_service_instance(ref_obj, ref_data)

Add service-instance to route-aggregate.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – ServiceInterfaceTag object
aggregate_route_entries

Get aggregate-route-entries for route-aggregate.

Returns:RouteListType object
aggregate_route_nexthop

Get aggregate-route-nexthop for route-aggregate.

Returns:xsd:string object
display_name

Get display-name for route-aggregate.

Returns:xsd:string object
dump()

Display route-aggregate object in compact form.

get_fq_name()

Return FQN of route-aggregate in list form.

get_fq_name_str()

Return FQN of route-aggregate as colon delimited string.

get_parent_fq_name()

Return FQN of route-aggregate’s parent in list form.

get_parent_fq_name_str()

Return FQN of route-aggregate’s parent as colon delimted string.

get_routing_instance_refs()

Return routing-instance list for route-aggregate.

Returns:list of <RoutingInstance>
get_service_instance_refs()

Return service-instance list for route-aggregate.

Returns:list of tuple <ServiceInstance, ServiceInterfaceTag>
get_type()

Return object type (route-aggregate).

id_perms

Get id-perms for route-aggregate.

Returns:IdPermsType object
perms2

Get perms2 for route-aggregate.

Returns:PermType2 object
set_routing_instance(ref_obj)

Set routing-instance for route-aggregate.

Parameters:ref_obj – RoutingInstance object
set_routing_instance_list(ref_obj_list)

Set routing-instance list for route-aggregate.

Parameters:ref_obj_list – list of RoutingInstance object
set_service_instance(ref_obj, ref_data)

Set service-instance for route-aggregate.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – ServiceInterfaceTag object
set_service_instance_list(ref_obj_list, ref_data_list)

Set service-instance list for route-aggregate.

Parameters:
  • ref_obj_list – list of ServiceInstance object
  • ref_data_list – list of ServiceInterfaceTag object
class vnc_cfg_api_server.gen.resource_common.RouteTable(name=None, parent_obj=None, routes=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents route-table configuration representation.

Child of:
Project object OR
Properties:
  • routes

    Type: RouteTableType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Routes in the route table are configured in following way.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
display_name

Get display-name for route-table.

Returns:xsd:string object
dump()

Display route-table object in compact form.

get_fq_name()

Return FQN of route-table in list form.

get_fq_name_str()

Return FQN of route-table as colon delimited string.

get_logical_router_back_refs()

Return list of all logical-routers using this route-table

get_parent_fq_name()

Return FQN of route-table’s parent in list form.

get_parent_fq_name_str()

Return FQN of route-table’s parent as colon delimted string.

get_type()

Return object type (route-table).

get_virtual_network_back_refs()

Return list of all virtual-networks using this route-table

id_perms

Get id-perms for route-table.

Returns:IdPermsType object
perms2

Get perms2 for route-table.

Returns:PermType2 object
routes

Get routes for route-table.

Returns:RouteTableType object
class vnc_cfg_api_server.gen.resource_common.RouteTarget(name=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents route-target configuration representation.

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
display_name

Get display-name for route-target.

Returns:xsd:string object
dump()

Display route-target object in compact form.

get_fq_name()

Return FQN of route-target in list form.

get_fq_name_str()

Return FQN of route-target as colon delimited string.

get_logical_router_back_refs()

Return list of all logical-routers using this route-target

get_routing_instance_back_refs()

Return list of all routing-instances using this route-target

get_type()

Return object type (route-target).

id_perms

Get id-perms for route-target.

Returns:IdPermsType object
perms2

Get perms2 for route-target.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.RoutingInstance(name=None, parent_obj=None, service_chain_information=None, ipv6_service_chain_information=None, routing_instance_is_default=False, routing_instance_has_pnf=False, static_route_entries=None, default_ce_protocol=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents routing-instance configuration representation.

Child of:
VirtualNetwork object OR
Properties:
  • service_chain_information

    Type: ServiceChainInfo

    Created By: System

    Operations Allowed: CRUD

    Description:

    Internal service chaining information, should not be modified.

  • ipv6_service_chain_information

    Type: ServiceChainInfo

    Created By: System

    Operations Allowed: CRUD

    Description:

    Internal service chaining information, should not be modified.

  • routing_instance_is_default

    Type: bool

    Created By: System

    Operations Allowed: CRUD

    Description:

    Internal service chaining information, should not be modified.

  • routing_instance_has_pnf

    Type: bool

    Created By: System

    Operations Allowed: CRUD

    Description:

    Internal service chaining information, should not be modified.

  • static_route_entries

    Type: StaticRouteEntriesType

    Created By: System

    Operations Allowed: CRUD

    Description:

    Internal service chaining information, should not be modified.

  • default_ce_protocol

    Type: DefaultProtocolType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of BgpRouter objects

    Created By: User (optionalCRUD)

    Operations Allowed: BGP router object represent configuration of BGP peers. All the BGP peers involved in contrail system are under default routing instance of the default virtual network.

    Description:

References to:
Referred by:
add_route_target(ref_obj, ref_data)

Add route-target to routing-instance.

Parameters:
  • ref_obj – RouteTarget object
  • ref_data – InstanceTargetType object
add_routing_instance(ref_obj, ref_data)

Add routing-instance to routing-instance.

Parameters:
  • ref_obj – RoutingInstance object
  • ref_data – ConnectionType object
default_ce_protocol

Get default-ce-protocol for routing-instance.

Returns:DefaultProtocolType object
display_name

Get display-name for routing-instance.

Returns:xsd:string object
dump()

Display routing-instance object in compact form.

get_fq_name()

Return FQN of routing-instance in list form.

get_fq_name_str()

Return FQN of routing-instance as colon delimited string.

get_parent_fq_name()

Return FQN of routing-instance’s parent in list form.

get_parent_fq_name_str()

Return FQN of routing-instance’s parent as colon delimted string.

get_route_aggregate_back_refs()

Return list of all route-aggregates using this routing-instance

get_route_target_refs()

Return route-target list for routing-instance.

Returns:list of tuple <RouteTarget, InstanceTargetType>
get_routing_instance_back_refs()

Return list of all routing-instances using this routing-instance

get_routing_instance_refs()

Return routing-instance list for routing-instance.

Returns:list of tuple <RoutingInstance, ConnectionType>
get_routing_policy_back_refs()

Return list of all routing-policys using this routing-instance

get_type()

Return object type (routing-instance).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this routing-instance

id_perms

Get id-perms for routing-instance.

Returns:IdPermsType object
ipv6_service_chain_information

Get ipv6-service-chain-information for routing-instance.

Returns:ServiceChainInfo object
perms2

Get perms2 for routing-instance.

Returns:PermType2 object
routing_instance_has_pnf

Get routing-instance-has-pnf for routing-instance.

Returns:xsd:boolean object
routing_instance_is_default

Get routing-instance-is-default for routing-instance.

Returns:xsd:boolean object
service_chain_information

Get service-chain-information for routing-instance.

Returns:ServiceChainInfo object
set_route_target(ref_obj, ref_data)

Set route-target for routing-instance.

Parameters:
  • ref_obj – RouteTarget object
  • ref_data – InstanceTargetType object
set_route_target_list(ref_obj_list, ref_data_list)

Set route-target list for routing-instance.

Parameters:
  • ref_obj_list – list of RouteTarget object
  • ref_data_list – list of InstanceTargetType object
set_routing_instance(ref_obj, ref_data)

Set routing-instance for routing-instance.

Parameters:
  • ref_obj – RoutingInstance object
  • ref_data – ConnectionType object
set_routing_instance_list(ref_obj_list, ref_data_list)

Set routing-instance list for routing-instance.

Parameters:
  • ref_obj_list – list of RoutingInstance object
  • ref_data_list – list of ConnectionType object
static_route_entries

Get static-route-entries for routing-instance.

Returns:StaticRouteEntriesType object
class vnc_cfg_api_server.gen.resource_common.RoutingPolicy(name=None, parent_obj=None, routing_policy_entries=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents routing-policy configuration representation.

Child of:
Project object OR
Properties:
  • routing_policy_entries

    Type: PolicyStatementType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of (ServiceInstance object, RoutingPolicyServiceInstanceType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to routing policy attached to (service instance, interface).

  • list of (RoutingInstance object, RoutingPolicyType attribute)

    Created By: User (Reference to internal routing instance object automatically generated by system. Reference has property of sequence number which is order of in which routing policies are applied to given routing instance.)

    Operations Allowed: CRUD

    Description:

Referred by:

add_routing_instance(ref_obj, ref_data)

Add routing-instance to routing-policy.

Parameters:
  • ref_obj – RoutingInstance object
  • ref_data – RoutingPolicyType object
add_service_instance(ref_obj, ref_data)

Add service-instance to routing-policy.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – RoutingPolicyServiceInstanceType object
display_name

Get display-name for routing-policy.

Returns:xsd:string object
dump()

Display routing-policy object in compact form.

get_fq_name()

Return FQN of routing-policy in list form.

get_fq_name_str()

Return FQN of routing-policy as colon delimited string.

get_parent_fq_name()

Return FQN of routing-policy’s parent in list form.

get_parent_fq_name_str()

Return FQN of routing-policy’s parent as colon delimted string.

get_routing_instance_refs()

Return routing-instance list for routing-policy.

Returns:list of tuple <RoutingInstance, RoutingPolicyType>
get_service_instance_refs()

Return service-instance list for routing-policy.

Returns:list of tuple <ServiceInstance, RoutingPolicyServiceInstanceType>
get_type()

Return object type (routing-policy).

id_perms

Get id-perms for routing-policy.

Returns:IdPermsType object
perms2

Get perms2 for routing-policy.

Returns:PermType2 object
routing_policy_entries

Get routing-policy-entries for routing-policy.

Returns:PolicyStatementType object
set_routing_instance(ref_obj, ref_data)

Set routing-instance for routing-policy.

Parameters:
  • ref_obj – RoutingInstance object
  • ref_data – RoutingPolicyType object
set_routing_instance_list(ref_obj_list, ref_data_list)

Set routing-instance list for routing-policy.

Parameters:
  • ref_obj_list – list of RoutingInstance object
  • ref_data_list – list of RoutingPolicyType object
set_service_instance(ref_obj, ref_data)

Set service-instance for routing-policy.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – RoutingPolicyServiceInstanceType object
set_service_instance_list(ref_obj_list, ref_data_list)

Set service-instance list for routing-policy.

Parameters:
  • ref_obj_list – list of ServiceInstance object
  • ref_data_list – list of RoutingPolicyServiceInstanceType object
class vnc_cfg_api_server.gen.resource_common.SecurityGroup(name=None, parent_obj=None, security_group_id=None, configured_security_group_id=None, security_group_entries=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents security-group configuration representation.

Child of:
Project object OR
Properties:
  • security_group_id

    Type: string

    Created By: System

    Operations Allowed: CR

    Description:

    Unique 32 bit ID automatically assigned to this security group [8M+1, 32G].

  • configured_security_group_id

    Type: int

    Created By: User (optional)

    Operations Allowed: CRUDUNIQUE 32 BIT USER DEFINED ID ASSIGNED TO THIS SECURITY GROUP [1, 8M].

    Description:

  • security_group_entries

    Type: PolicyEntriesType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Security group rule entries.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of AccessControlList objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    port access control list is automatcally derived from all the security groups attached to port.

References to:

Referred by:
configured_security_group_id

Get configured-security-group-id for security-group.

Returns:xsd:integer object
display_name

Get display-name for security-group.

Returns:xsd:string object
dump()

Display security-group object in compact form.

get_fq_name()

Return FQN of security-group in list form.

get_fq_name_str()

Return FQN of security-group as colon delimited string.

get_parent_fq_name()

Return FQN of security-group’s parent in list form.

get_parent_fq_name_str()

Return FQN of security-group’s parent as colon delimted string.

get_type()

Return object type (security-group).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this security-group

id_perms

Get id-perms for security-group.

Returns:IdPermsType object
perms2

Get perms2 for security-group.

Returns:PermType2 object
security_group_entries

Get security-group-entries for security-group.

Returns:PolicyEntriesType object
security_group_id

Get security-group-id for security-group.

Returns:xsd:string object
class vnc_cfg_api_server.gen.resource_common.ServiceAppliance(name=None, parent_obj=None, service_appliance_user_credentials=None, service_appliance_ip_address=None, service_appliance_properties=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents service-appliance configuration representation.

Child of:
ServiceApplianceSet object OR
Properties:
  • service_appliance_user_credentials

    Type: UserCredentials

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Authentication credentials for driver to access service appliance.

  • service_appliance_ip_address

    Type: string, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Manegment Ip address of the service-appliance.

  • service_appliance_properties

    Type: KeyValuePairs

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    List of Key:Value pairs used by the provider driver of this service appliance.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of (PhysicalInterface object, ServiceApplianceInterfaceType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to physical interface that can be used as (service interface type)left, right, manegement

    OR other.

Referred by:

add_physical_interface(ref_obj, ref_data)

Add physical-interface to service-appliance.

Parameters:
  • ref_obj – PhysicalInterface object
  • ref_data – ServiceApplianceInterfaceType object
display_name

Get display-name for service-appliance.

Returns:xsd:string object
dump()

Display service-appliance object in compact form.

get_fq_name()

Return FQN of service-appliance in list form.

get_fq_name_str()

Return FQN of service-appliance as colon delimited string.

get_parent_fq_name()

Return FQN of service-appliance’s parent in list form.

get_parent_fq_name_str()

Return FQN of service-appliance’s parent as colon delimted string.

get_physical_interface_refs()

Return physical-interface list for service-appliance.

Returns:list of tuple <PhysicalInterface, ServiceApplianceInterfaceType>
get_type()

Return object type (service-appliance).

id_perms

Get id-perms for service-appliance.

Returns:IdPermsType object
perms2

Get perms2 for service-appliance.

Returns:PermType2 object
service_appliance_ip_address

Get service-appliance-ip-address for service-appliance.

Returns:IpAddressType object
service_appliance_properties

Get service-appliance-properties for service-appliance.

Returns:KeyValuePairs object
service_appliance_user_credentials

Get service-appliance-user-credentials for service-appliance.

Returns:UserCredentials object
set_physical_interface(ref_obj, ref_data)

Set physical-interface for service-appliance.

Parameters:
  • ref_obj – PhysicalInterface object
  • ref_data – ServiceApplianceInterfaceType object
set_physical_interface_list(ref_obj_list, ref_data_list)

Set physical-interface list for service-appliance.

Parameters:
  • ref_obj_list – list of PhysicalInterface object
  • ref_data_list – list of ServiceApplianceInterfaceType object
class vnc_cfg_api_server.gen.resource_common.ServiceApplianceSet(name=None, parent_obj=None, service_appliance_set_properties=None, service_appliance_driver=None, service_appliance_ha_mode=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents service-appliance-set configuration representation.

Child of:
GlobalSystemConfig object OR
Properties:
  • service_appliance_set_properties

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of Key:Value pairs that are used by the provider driver and opaque to system.

  • service_appliance_driver

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Name of the provider driver for this service appliance set.

  • service_appliance_ha_mode

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    High availability mode for the service appliance set, active-active or active-backup.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of ServiceAppliance objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Service appliance is a member in service appliance set (e.g. Loadbalancer, Firewall provider).By

    default system will create “ha-proxy” based service appliance.

References to:

Referred by:
display_name

Get display-name for service-appliance-set.

Returns:xsd:string object
dump()

Display service-appliance-set object in compact form.

get_fq_name()

Return FQN of service-appliance-set in list form.

get_fq_name_str()

Return FQN of service-appliance-set as colon delimited string.

get_loadbalancer_pool_back_refs()

Return list of all loadbalancer-pools using this service-appliance-set

get_parent_fq_name()

Return FQN of service-appliance-set’s parent in list form.

get_parent_fq_name_str()

Return FQN of service-appliance-set’s parent as colon delimted string.

get_service_template_back_refs()

Return list of all service-templates using this service-appliance-set

get_type()

Return object type (service-appliance-set).

id_perms

Get id-perms for service-appliance-set.

Returns:IdPermsType object
perms2

Get perms2 for service-appliance-set.

Returns:PermType2 object
service_appliance_driver

Get service-appliance-driver for service-appliance-set.

Returns:xsd:string object
service_appliance_ha_mode

Get service-appliance-ha-mode for service-appliance-set.

Returns:xsd:string object
service_appliance_set_properties

Get service-appliance-set-properties for service-appliance-set.

Returns:KeyValuePairs object
class vnc_cfg_api_server.gen.resource_common.ServiceHealthCheck(name=None, parent_obj=None, service_health_check_properties=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents service-health-check configuration representation.

Child of:
Project object OR
Properties:
  • service_health_check_properties

    Type: ServiceHealthCheckType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Service health check has following fields.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of (ServiceInstance object, ServiceInterfaceTag attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to service instance using this service health check.

Referred by:
add_service_instance(ref_obj, ref_data)

Add service-instance to service-health-check.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – ServiceInterfaceTag object
display_name

Get display-name for service-health-check.

Returns:xsd:string object
dump()

Display service-health-check object in compact form.

get_fq_name()

Return FQN of service-health-check in list form.

get_fq_name_str()

Return FQN of service-health-check as colon delimited string.

get_parent_fq_name()

Return FQN of service-health-check’s parent in list form.

get_parent_fq_name_str()

Return FQN of service-health-check’s parent as colon delimted string.

get_service_instance_refs()

Return service-instance list for service-health-check.

Returns:list of tuple <ServiceInstance, ServiceInterfaceTag>
get_type()

Return object type (service-health-check).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this service-health-check

id_perms

Get id-perms for service-health-check.

Returns:IdPermsType object
perms2

Get perms2 for service-health-check.

Returns:PermType2 object
service_health_check_properties

Get service-health-check-properties for service-health-check.

Returns:ServiceHealthCheckType object
set_service_instance(ref_obj, ref_data)

Set service-instance for service-health-check.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – ServiceInterfaceTag object
set_service_instance_list(ref_obj_list, ref_data_list)

Set service-instance list for service-health-check.

Parameters:
  • ref_obj_list – list of ServiceInstance object
  • ref_data_list – list of ServiceInterfaceTag object
class vnc_cfg_api_server.gen.resource_common.ServiceInstance(name=None, parent_obj=None, service_instance_properties=None, service_instance_bindings=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents service-instance configuration representation.

Child of:
Project object OR
Properties:
  • service_instance_properties

    Type: ServiceInstanceType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Service instance configuration parameters.

  • service_instance_bindings

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Opaque key value pair for generating config for the service instance.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of PortTuple objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Port tuples are ordered set of interfaces that represent a service virtual machine or physical

    device , which is part of this service instance.

    Order of interfaces in port tuple is same as specified in the service template.

    example SI = [(Left, Right, Management), (L, R, M), ..., (L, R, M)].

References to:
  • list of ServiceTemplate objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Reference to the service template of this service instance.

  • list of (InstanceIp object, ServiceInterfaceTag attribute)

    Created By: System

    Operations Allowed: CRUD

    Description:

    Reference to ip address, which is used as nexthop pointing to (service instance, service interface).

Referred by:
add_instance_ip(ref_obj, ref_data)

Add instance-ip to service-instance.

Parameters:
  • ref_obj – InstanceIp object
  • ref_data – ServiceInterfaceTag object
add_service_template(ref_obj)

Add service-template to service-instance.

Parameters:ref_obj – ServiceTemplate object
display_name

Get display-name for service-instance.

Returns:xsd:string object
dump()

Display service-instance object in compact form.

get_fq_name()

Return FQN of service-instance in list form.

get_fq_name_str()

Return FQN of service-instance as colon delimited string.

get_instance_ip_refs()

Return instance-ip list for service-instance.

Returns:list of tuple <InstanceIp, ServiceInterfaceTag>
get_interface_route_table_back_refs()

Return list of all interface-route-tables using this service-instance

get_loadbalancer_back_refs()

Return list of all loadbalancers using this service-instance

get_loadbalancer_pool_back_refs()

Return list of all loadbalancer-pools using this service-instance

get_logical_router_back_refs()

Return list of all logical-routers using this service-instance

get_parent_fq_name()

Return FQN of service-instance’s parent in list form.

get_parent_fq_name_str()

Return FQN of service-instance’s parent as colon delimted string.

get_route_aggregate_back_refs()

Return list of all route-aggregates using this service-instance

get_routing_policy_back_refs()

Return list of all routing-policys using this service-instance

get_service_health_check_back_refs()

Return list of all service-health-checks using this service-instance

get_service_template_refs()

Return service-template list for service-instance.

Returns:list of <ServiceTemplate>
get_type()

Return object type (service-instance).

get_virtual_machine_back_refs()

Return list of all virtual-machines using this service-instance

id_perms

Get id-perms for service-instance.

Returns:IdPermsType object
perms2

Get perms2 for service-instance.

Returns:PermType2 object
service_instance_bindings

Get service-instance-bindings for service-instance.

Returns:KeyValuePairs object
service_instance_properties

Get service-instance-properties for service-instance.

Returns:ServiceInstanceType object
set_instance_ip(ref_obj, ref_data)

Set instance-ip for service-instance.

Parameters:
  • ref_obj – InstanceIp object
  • ref_data – ServiceInterfaceTag object
set_instance_ip_list(ref_obj_list, ref_data_list)

Set instance-ip list for service-instance.

Parameters:
  • ref_obj_list – list of InstanceIp object
  • ref_data_list – list of ServiceInterfaceTag object
set_service_template(ref_obj)

Set service-template for service-instance.

Parameters:ref_obj – ServiceTemplate object
set_service_template_list(ref_obj_list)

Set service-template list for service-instance.

Parameters:ref_obj_list – list of ServiceTemplate object
class vnc_cfg_api_server.gen.resource_common.ServiceTemplate(name=None, parent_obj=None, service_template_properties=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents service-template configuration representation.

Child of:
Domain object OR
Properties:
  • service_template_properties

    Type: ServiceTemplateType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Service template confurigation parameters.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of ServiceApplianceSet objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to the service apliance set represented by this service template.

Referred by:
add_service_appliance_set(ref_obj)

Add service-appliance-set to service-template.

Parameters:ref_obj – ServiceApplianceSet object
display_name

Get display-name for service-template.

Returns:xsd:string object
dump()

Display service-template object in compact form.

get_fq_name()

Return FQN of service-template in list form.

get_fq_name_str()

Return FQN of service-template as colon delimited string.

get_parent_fq_name()

Return FQN of service-template’s parent in list form.

get_parent_fq_name_str()

Return FQN of service-template’s parent as colon delimted string.

get_service_appliance_set_refs()

Return service-appliance-set list for service-template.

Returns:list of <ServiceApplianceSet>
get_service_instance_back_refs()

Return list of all service-instances using this service-template

get_type()

Return object type (service-template).

id_perms

Get id-perms for service-template.

Returns:IdPermsType object
perms2

Get perms2 for service-template.

Returns:PermType2 object
service_template_properties

Get service-template-properties for service-template.

Returns:ServiceTemplateType object
set_service_appliance_set(ref_obj)

Set service-appliance-set for service-template.

Parameters:ref_obj – ServiceApplianceSet object
set_service_appliance_set_list(ref_obj_list)

Set service-appliance-set list for service-template.

Parameters:ref_obj_list – list of ServiceApplianceSet object
class vnc_cfg_api_server.gen.resource_common.Subnet(name=None, subnet_ip_prefix=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents subnet configuration representation.

Properties:
  • subnet_ip_prefix

    Type: SubnetType

    Created By: User (required)

    Operations Allowed: CRD

    Description:

    Ip prefix/length of the subnet.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Subnet belongs of the refernced virtual machine interface. This is used in CPE use case when a

    subnet is reachable via the interface. It also serves as dynamic DHCP pool for host on this LAN,

    where vrouter is DHCP server.

Referred by:

add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to subnet.

Parameters:ref_obj – VirtualMachineInterface object
display_name

Get display-name for subnet.

Returns:xsd:string object
dump()

Display subnet object in compact form.

get_fq_name()

Return FQN of subnet in list form.

get_fq_name_str()

Return FQN of subnet as colon delimited string.

get_type()

Return object type (subnet).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for subnet.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for subnet.

Returns:IdPermsType object
perms2

Get perms2 for subnet.

Returns:PermType2 object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for subnet.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for subnet.

Parameters:ref_obj_list – list of VirtualMachineInterface object
subnet_ip_prefix

Get subnet-ip-prefix for subnet.

Returns:SubnetType object
class vnc_cfg_api_server.gen.resource_common.VirtualDns(name=None, parent_obj=None, virtual_DNS_data=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents virtual-DNS configuration representation.

Child of:
Domain object OR
Properties:
  • virtual_DNS_data

    Type: VirtualDnsType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Virtua DNS data has configuration for virtual DNS like domain, dynamic records etc.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of VirtualDnsRecord objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Static DNS records in virtual DNS server.

References to:

Referred by:
display_name

Get display-name for virtual-DNS.

Returns:xsd:string object
dump()

Display virtual-DNS object in compact form.

get_fq_name()

Return FQN of virtual-DNS in list form.

get_fq_name_str()

Return FQN of virtual-DNS as colon delimited string.

get_network_ipam_back_refs()

Return list of all network-ipams using this virtual-DNS

get_parent_fq_name()

Return FQN of virtual-DNS’s parent in list form.

get_parent_fq_name_str()

Return FQN of virtual-DNS’s parent as colon delimted string.

get_type()

Return object type (virtual-DNS).

id_perms

Get id-perms for virtual-DNS.

Returns:IdPermsType object
perms2

Get perms2 for virtual-DNS.

Returns:PermType2 object
virtual_DNS_data

Get virtual-DNS-data for virtual-DNS.

Returns:VirtualDnsType object
class vnc_cfg_api_server.gen.resource_common.VirtualDnsRecord(name=None, parent_obj=None, virtual_DNS_record_data=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents virtual-DNS-record configuration representation.

Child of:
VirtualDns object OR
Properties:
  • virtual_DNS_record_data

    Type: VirtualDnsRecordType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    DNS record data has configuration like type, name, ip address, loadbalancing etc.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

display_name

Get display-name for virtual-DNS-record.

Returns:xsd:string object
dump()

Display virtual-DNS-record object in compact form.

get_fq_name()

Return FQN of virtual-DNS-record in list form.

get_fq_name_str()

Return FQN of virtual-DNS-record as colon delimited string.

get_parent_fq_name()

Return FQN of virtual-DNS-record’s parent in list form.

get_parent_fq_name_str()

Return FQN of virtual-DNS-record’s parent as colon delimted string.

get_type()

Return object type (virtual-DNS-record).

id_perms

Get id-perms for virtual-DNS-record.

Returns:IdPermsType object
perms2

Get perms2 for virtual-DNS-record.

Returns:PermType2 object
virtual_DNS_record_data

Get virtual-DNS-record-data for virtual-DNS-record.

Returns:VirtualDnsRecordType object
class vnc_cfg_api_server.gen.resource_common.VirtualIp(name=None, parent_obj=None, virtual_ip_properties=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents virtual-ip configuration representation.

Child of:
Project object OR
Properties:
  • virtual_ip_properties

    Type: VirtualIpType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Virtual ip configuration like port, protocol, subnet etc.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of LoadbalancerPool objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to the load balancer pool that this virtual ip represent. Applicable only to LBaaS V1

  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to the virtual machine interface for virtual ip. Applicable only to LBaaS V1

Referred by:

add_loadbalancer_pool(ref_obj)

Add loadbalancer-pool to virtual-ip.

Parameters:ref_obj – LoadbalancerPool object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to virtual-ip.

Parameters:ref_obj – VirtualMachineInterface object
display_name

Get display-name for virtual-ip.

Returns:xsd:string object
dump()

Display virtual-ip object in compact form.

get_fq_name()

Return FQN of virtual-ip in list form.

get_fq_name_str()

Return FQN of virtual-ip as colon delimited string.

get_loadbalancer_pool_refs()

Return loadbalancer-pool list for virtual-ip.

Returns:list of <LoadbalancerPool>
get_parent_fq_name()

Return FQN of virtual-ip’s parent in list form.

get_parent_fq_name_str()

Return FQN of virtual-ip’s parent as colon delimted string.

get_type()

Return object type (virtual-ip).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for virtual-ip.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for virtual-ip.

Returns:IdPermsType object
perms2

Get perms2 for virtual-ip.

Returns:PermType2 object
set_loadbalancer_pool(ref_obj)

Set loadbalancer-pool for virtual-ip.

Parameters:ref_obj – LoadbalancerPool object
set_loadbalancer_pool_list(ref_obj_list)

Set loadbalancer-pool list for virtual-ip.

Parameters:ref_obj_list – list of LoadbalancerPool object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for virtual-ip.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for virtual-ip.

Parameters:ref_obj_list – list of VirtualMachineInterface object
virtual_ip_properties

Get virtual-ip-properties for virtual-ip.

Returns:VirtualIpType object
class vnc_cfg_api_server.gen.resource_common.VirtualMachine(name=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents virtual-machine configuration representation.

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    References to child interfaces this virtual machine has, this is being DEPRICATED.

References to:
  • list of ServiceInstance objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Reference to the service instance of this virtual machine.

Referred by:
add_service_instance(ref_obj)

Add service-instance to virtual-machine.

Parameters:ref_obj – ServiceInstance object
display_name

Get display-name for virtual-machine.

Returns:xsd:string object
dump()

Display virtual-machine object in compact form.

get_fq_name()

Return FQN of virtual-machine in list form.

get_fq_name_str()

Return FQN of virtual-machine as colon delimited string.

get_service_instance_refs()

Return service-instance list for virtual-machine.

Returns:list of <ServiceInstance>
get_type()

Return object type (virtual-machine).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this virtual-machine

get_virtual_router_back_refs()

Return list of all virtual-routers using this virtual-machine

id_perms

Get id-perms for virtual-machine.

Returns:IdPermsType object
perms2

Get perms2 for virtual-machine.

Returns:PermType2 object
set_service_instance(ref_obj)

Set service-instance for virtual-machine.

Parameters:ref_obj – ServiceInstance object
set_service_instance_list(ref_obj_list)

Set service-instance list for virtual-machine.

Parameters:ref_obj_list – list of ServiceInstance object
class vnc_cfg_api_server.gen.resource_common.VirtualMachineInterface(name=None, parent_obj=None, ecmp_hashing_include_fields=None, virtual_machine_interface_mac_addresses=None, virtual_machine_interface_dhcp_option_list=None, virtual_machine_interface_host_routes=None, virtual_machine_interface_allowed_address_pairs=None, vrf_assign_table=None, virtual_machine_interface_device_owner=None, virtual_machine_interface_disable_policy=False, virtual_machine_interface_properties=None, virtual_machine_interface_bindings=None, virtual_machine_interface_fat_flow_protocols=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents virtual-machine-interface configuration representation.

Child of:
VirtualMachine object OR Project object OR
Properties:
  • ecmp_hashing_include_fields

    Type: EcmpHashingIncludeFields

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    ECMP hashing config at global level.

  • virtual_machine_interface_mac_addresses

    Type: MacAddressesType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    MAC address of the virtual machine interface, automatically assigned by system if not provided.

  • virtual_machine_interface_dhcp_option_list

    Type: DhcpOptionsListType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    DHCP options configuration specific to this interface.

  • virtual_machine_interface_host_routes

    Type: RouteTableType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of host routes(prefixes, nexthop) that are passed to VM via DHCP.

  • virtual_machine_interface_allowed_address_pairs

    Type: AllowedAddressPairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of (IP address, MAC) other than instance ip on this interface.

  • vrf_assign_table

    Type: VrfAssignTableType

    Created By: System

    Operations Allowed: CRUD

    Description:

    VRF assignment policy for this interface, automatically generated by system.

  • virtual_machine_interface_device_owner

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    For openstack compatibility, not used by system.

  • virtual_machine_interface_disable_policy

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    When True all policy checks for ingress and egress traffic from this interface are disabled. Flow

    table entries are not created.

  • virtual_machine_interface_properties

    Type: VirtualMachineInterfacePropertiesType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Virtual Machine Interface miscelenious configurations.

  • virtual_machine_interface_bindings

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) for this interface. Neutron port bindings use this.

  • virtual_machine_interface_fat_flow_protocols

    Type: FatFlowProtocols

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of (protocol, port number), for flows to interface with (protocol, destination port number),

    vrouter will ignore source port while setting up flow and ignore it as source port in reverse flow.

    Hence many flows will map to single flow.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of QosConfig objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to QoS config for this virtual machine interface.

  • list of SecurityGroup objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Interface ACL, Automatically generated by system based on security groups attached to this

    interface.

  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of references to the sub interfaces of this interface.

  • list of VirtualMachine objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This interface belongs to the referenced virtual machine.

  • list of VirtualNetwork objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    This interface is member of the referenced virtual network.

  • list of (RoutingInstance object, PolicyBasedForwardingRuleType attribute)

    Created By: System

    Operations Allowed: CRUD

    Description:

    Automatically generated Forwarding policy. This will be depricated in future in favour of VRF assign

    rules.

  • list of PortTuple objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Ordered set of references to the interfaces in this port tuple.

    Order is same as specified in the service interface.

    example (left, right, manegement, other1).

  • list of ServiceHealthCheck objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Refernce to health check object attached to this interface.

  • list of InterfaceRouteTable objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to the interface route table attached to this interface.

  • list of PhysicalInterface objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Reference to the physical interface of service appliance this service interface represents.

Referred by:
add_interface_route_table(ref_obj)

Add interface-route-table to virtual-machine-interface.

Parameters:ref_obj – InterfaceRouteTable object
add_physical_interface(ref_obj)

Add physical-interface to virtual-machine-interface.

Parameters:ref_obj – PhysicalInterface object
add_port_tuple(ref_obj)

Add port-tuple to virtual-machine-interface.

Parameters:ref_obj – PortTuple object
add_qos_config(ref_obj)

Add qos-config to virtual-machine-interface.

Parameters:ref_obj – QosConfig object
add_routing_instance(ref_obj, ref_data)

Add routing-instance to virtual-machine-interface.

Parameters:
  • ref_obj – RoutingInstance object
  • ref_data – PolicyBasedForwardingRuleType object
add_security_group(ref_obj)

Add security-group to virtual-machine-interface.

Parameters:ref_obj – SecurityGroup object
add_service_health_check(ref_obj)

Add service-health-check to virtual-machine-interface.

Parameters:ref_obj – ServiceHealthCheck object
add_virtual_machine(ref_obj)

Add virtual-machine to virtual-machine-interface.

Parameters:ref_obj – VirtualMachine object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to virtual-machine-interface.

Parameters:ref_obj – VirtualMachineInterface object
add_virtual_network(ref_obj)

Add virtual-network to virtual-machine-interface.

Parameters:ref_obj – VirtualNetwork object
display_name

Get display-name for virtual-machine-interface.

Returns:xsd:string object
dump()

Display virtual-machine-interface object in compact form.

ecmp_hashing_include_fields

Get ecmp-hashing-include-fields for virtual-machine-interface.

Returns:EcmpHashingIncludeFields object
get_alias_ip_back_refs()

Return list of all alias-ips using this virtual-machine-interface

get_bgp_as_a_service_back_refs()

Return list of all bgp-as-a-services using this virtual-machine-interface

get_customer_attachment_back_refs()

Return list of all customer-attachments using this virtual-machine-interface

get_floating_ip_back_refs()

Return list of all floating-ips using this virtual-machine-interface

get_fq_name()

Return FQN of virtual-machine-interface in list form.

get_fq_name_str()

Return FQN of virtual-machine-interface as colon delimited string.

get_instance_ip_back_refs()

Return list of all instance-ips using this virtual-machine-interface

get_interface_route_table_refs()

Return interface-route-table list for virtual-machine-interface.

Returns:list of <InterfaceRouteTable>
get_loadbalancer_back_refs()

Return list of all loadbalancers using this virtual-machine-interface

get_loadbalancer_pool_back_refs()

Return list of all loadbalancer-pools using this virtual-machine-interface

get_logical_interface_back_refs()

Return list of all logical-interfaces using this virtual-machine-interface

get_logical_router_back_refs()

Return list of all logical-routers using this virtual-machine-interface

get_parent_fq_name()

Return FQN of virtual-machine-interface’s parent in list form.

get_parent_fq_name_str()

Return FQN of virtual-machine-interface’s parent as colon delimted string.

get_physical_interface_refs()

Return physical-interface list for virtual-machine-interface.

Returns:list of <PhysicalInterface>
get_port_tuple_refs()

Return port-tuple list for virtual-machine-interface.

Returns:list of <PortTuple>
get_qos_config_refs()

Return qos-config list for virtual-machine-interface.

Returns:list of <QosConfig>
get_routing_instance_refs()

Return routing-instance list for virtual-machine-interface.

Returns:list of tuple <RoutingInstance, PolicyBasedForwardingRuleType>
get_security_group_refs()

Return security-group list for virtual-machine-interface.

Returns:list of <SecurityGroup>
get_service_health_check_refs()

Return service-health-check list for virtual-machine-interface.

Returns:list of <ServiceHealthCheck>
get_subnet_back_refs()

Return list of all subnets using this virtual-machine-interface

get_type()

Return object type (virtual-machine-interface).

get_virtual_ip_back_refs()

Return list of all virtual-ips using this virtual-machine-interface

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this virtual-machine-interface

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for virtual-machine-interface.

Returns:list of <VirtualMachineInterface>
get_virtual_machine_refs()

Return virtual-machine list for virtual-machine-interface.

Returns:list of <VirtualMachine>
get_virtual_network_refs()

Return virtual-network list for virtual-machine-interface.

Returns:list of <VirtualNetwork>
id_perms

Get id-perms for virtual-machine-interface.

Returns:IdPermsType object
perms2

Get perms2 for virtual-machine-interface.

Returns:PermType2 object
set_interface_route_table(ref_obj)

Set interface-route-table for virtual-machine-interface.

Parameters:ref_obj – InterfaceRouteTable object
set_interface_route_table_list(ref_obj_list)

Set interface-route-table list for virtual-machine-interface.

Parameters:ref_obj_list – list of InterfaceRouteTable object
set_physical_interface(ref_obj)

Set physical-interface for virtual-machine-interface.

Parameters:ref_obj – PhysicalInterface object
set_physical_interface_list(ref_obj_list)

Set physical-interface list for virtual-machine-interface.

Parameters:ref_obj_list – list of PhysicalInterface object
set_port_tuple(ref_obj)

Set port-tuple for virtual-machine-interface.

Parameters:ref_obj – PortTuple object
set_port_tuple_list(ref_obj_list)

Set port-tuple list for virtual-machine-interface.

Parameters:ref_obj_list – list of PortTuple object
set_qos_config(ref_obj)

Set qos-config for virtual-machine-interface.

Parameters:ref_obj – QosConfig object
set_qos_config_list(ref_obj_list)

Set qos-config list for virtual-machine-interface.

Parameters:ref_obj_list – list of QosConfig object
set_routing_instance(ref_obj, ref_data)

Set routing-instance for virtual-machine-interface.

Parameters:
  • ref_obj – RoutingInstance object
  • ref_data – PolicyBasedForwardingRuleType object
set_routing_instance_list(ref_obj_list, ref_data_list)

Set routing-instance list for virtual-machine-interface.

Parameters:
  • ref_obj_list – list of RoutingInstance object
  • ref_data_list – list of PolicyBasedForwardingRuleType object
set_security_group(ref_obj)

Set security-group for virtual-machine-interface.

Parameters:ref_obj – SecurityGroup object
set_security_group_list(ref_obj_list)

Set security-group list for virtual-machine-interface.

Parameters:ref_obj_list – list of SecurityGroup object
set_service_health_check(ref_obj)

Set service-health-check for virtual-machine-interface.

Parameters:ref_obj – ServiceHealthCheck object
set_service_health_check_list(ref_obj_list)

Set service-health-check list for virtual-machine-interface.

Parameters:ref_obj_list – list of ServiceHealthCheck object
set_virtual_machine(ref_obj)

Set virtual-machine for virtual-machine-interface.

Parameters:ref_obj – VirtualMachine object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for virtual-machine-interface.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for virtual-machine-interface.

Parameters:ref_obj_list – list of VirtualMachineInterface object
set_virtual_machine_list(ref_obj_list)

Set virtual-machine list for virtual-machine-interface.

Parameters:ref_obj_list – list of VirtualMachine object
set_virtual_network(ref_obj)

Set virtual-network for virtual-machine-interface.

Parameters:ref_obj – VirtualNetwork object
set_virtual_network_list(ref_obj_list)

Set virtual-network list for virtual-machine-interface.

Parameters:ref_obj_list – list of VirtualNetwork object
virtual_machine_interface_allowed_address_pairs

Get virtual-machine-interface-allowed-address-pairs for virtual-machine-interface.

Returns:AllowedAddressPairs object
virtual_machine_interface_bindings

Get virtual-machine-interface-bindings for virtual-machine-interface.

Returns:KeyValuePairs object
virtual_machine_interface_device_owner

Get virtual-machine-interface-device-owner for virtual-machine-interface.

Returns:xsd:string object
virtual_machine_interface_dhcp_option_list

Get virtual-machine-interface-dhcp-option-list for virtual-machine-interface.

Returns:DhcpOptionsListType object
virtual_machine_interface_disable_policy

Get virtual-machine-interface-disable-policy for virtual-machine-interface.

Returns:xsd:boolean object
virtual_machine_interface_fat_flow_protocols

Get virtual-machine-interface-fat-flow-protocols for virtual-machine-interface.

Returns:FatFlowProtocols object
virtual_machine_interface_host_routes

Get virtual-machine-interface-host-routes for virtual-machine-interface.

Returns:RouteTableType object
virtual_machine_interface_mac_addresses

Get virtual-machine-interface-mac-addresses for virtual-machine-interface.

Returns:MacAddressesType object
virtual_machine_interface_properties

Get virtual-machine-interface-properties for virtual-machine-interface.

Returns:VirtualMachineInterfacePropertiesType object
vrf_assign_table

Get vrf-assign-table for virtual-machine-interface.

Returns:VrfAssignTableType object
class vnc_cfg_api_server.gen.resource_common.VirtualNetwork(name=None, parent_obj=None, ecmp_hashing_include_fields=None, virtual_network_properties=None, provider_properties=None, virtual_network_network_id=None, route_target_list=None, import_route_target_list=None, export_route_target_list=None, router_external=None, is_shared=None, external_ipam=None, flood_unknown_unicast=False, multi_policy_service_chains_enabled=None, address_allocation_mode=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents virtual-network configuration representation.

Child of:
Project object OR
Properties:
  • ecmp_hashing_include_fields

    Type: EcmpHashingIncludeFields

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    ECMP hashing config at global level.

  • virtual_network_properties

    Type: VirtualNetworkType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Virtual network miscelenious configurations.

  • provider_properties

    Type: ProviderDetails

    Created By: User (optional)

    Operations Allowed: CRD

    Description:

    Virtual network is provider network. Specifies VLAN tag and physical network name.

  • virtual_network_network_id

    Type: int

    Created By: System

    Operations Allowed: CR

    Description:

    System assigned unique 32 bit ID for every virtual network.

  • route_target_list

    Type: RouteTargetList

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of route targets that are used as both import and export for this virtual network.

  • import_route_target_list

    Type: RouteTargetList

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of route targets that are used as import for this virtual network.

  • export_route_target_list

    Type: RouteTargetList

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of route targets that are used as export for this virtual network.

  • router_external

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    When true, this virtual network is openstack router external network.

  • is_shared

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    When true, this virtual network is shared with all tenants.

  • external_ipam

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    IP address assignment to VM is done statically, outside of (external to) Contrail Ipam. vCenter only

    feature.

  • flood_unknown_unicast

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    When true, packets with unknown unicast MAC addres are flooded within the network. Default they are

    dropped.

  • multi_policy_service_chains_enabled

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Allow multiple service chains within same two networks based on network policy.

    Current limitation is that both networks must reside within cluster, except when right most service

    is NAT.

  • address_allocation_mode

    Type: string, one-of [u’user-defined-subnet-preferred’, u’user-defined-subnet-only’, u’flat-subnet-preferred’, u’flat-subnet-only’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Address allocation mode for virtual network.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of AccessControlList objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Virtual network access control list are automatically derived from all the network policies attached

    to virtual network.

  • list of FloatingIpPool objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Floating ip pool is set of ip address that are carved out of a given network. Ip(s) from this set

    can be assigned to (virtual machine interface, ip) so that they become members of this network using

    one:one NAT.

  • list of AliasIpPool objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Alias ip pool is set of addresses that are carved out of a given network. Ip(s) from this set can be

    assigned to virtual-machine-interface so that they become members of this network

  • list of RoutingInstance objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    List of references of routing instances for this virtual network, routing instances are internal to

    the system.

References to:
  • list of QosConfig objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to QoS configuration for this virtual network.

  • list of (NetworkIpam object, VnSubnetsType attribute)

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Reference to network-ipam this network is using. It has list of subnets that are being used as

    property of the refernce.

  • list of (NetworkPolicy object, VirtualNetworkPolicyType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to network-policy attached to this network. It has sequence number to specify attachment

    order.

  • list of RouteTable objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Refernce to route table attached to this virtual network.

Referred by:
add_network_ipam(ref_obj, ref_data)

Add network-ipam to virtual-network.

Parameters:
  • ref_obj – NetworkIpam object
  • ref_data – VnSubnetsType object
add_network_policy(ref_obj, ref_data)

Add network-policy to virtual-network.

Parameters:
  • ref_obj – NetworkPolicy object
  • ref_data – VirtualNetworkPolicyType object
add_qos_config(ref_obj)

Add qos-config to virtual-network.

Parameters:ref_obj – QosConfig object
add_route_table(ref_obj)

Add route-table to virtual-network.

Parameters:ref_obj – RouteTable object
address_allocation_mode

Get address-allocation-mode for virtual-network.

Returns:AddressAllocationModeType object
display_name

Get display-name for virtual-network.

Returns:xsd:string object
dump()

Display virtual-network object in compact form.

ecmp_hashing_include_fields

Get ecmp-hashing-include-fields for virtual-network.

Returns:EcmpHashingIncludeFields object
export_route_target_list

Get export-route-target-list for virtual-network.

Returns:RouteTargetList object
external_ipam

Get external-ipam for virtual-network.

Returns:xsd:boolean object
flood_unknown_unicast

Get flood-unknown-unicast for virtual-network.

Returns:xsd:boolean object
get_fq_name()

Return FQN of virtual-network in list form.

get_fq_name_str()

Return FQN of virtual-network as colon delimited string.

get_instance_ip_back_refs()

Return list of all instance-ips using this virtual-network

get_logical_router_back_refs()

Return list of all logical-routers using this virtual-network

get_network_ipam_refs()

Return network-ipam list for virtual-network.

Returns:list of tuple <NetworkIpam, VnSubnetsType>
get_network_policy_refs()

Return network-policy list for virtual-network.

Returns:list of tuple <NetworkPolicy, VirtualNetworkPolicyType>
get_parent_fq_name()

Return FQN of virtual-network’s parent in list form.

get_parent_fq_name_str()

Return FQN of virtual-network’s parent as colon delimted string.

get_physical_router_back_refs()

Return list of all physical-routers using this virtual-network

get_qos_config_refs()

Return qos-config list for virtual-network.

Returns:list of <QosConfig>
get_route_table_refs()

Return route-table list for virtual-network.

Returns:list of <RouteTable>
get_type()

Return object type (virtual-network).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this virtual-network

id_perms

Get id-perms for virtual-network.

Returns:IdPermsType object
import_route_target_list

Get import-route-target-list for virtual-network.

Returns:RouteTargetList object
is_shared

Get is-shared for virtual-network.

Returns:xsd:boolean object
multi_policy_service_chains_enabled

Get multi-policy-service-chains-enabled for virtual-network.

Returns:xsd:boolean object
perms2

Get perms2 for virtual-network.

Returns:PermType2 object
provider_properties

Get provider-properties for virtual-network.

Returns:ProviderDetails object
route_target_list

Get route-target-list for virtual-network.

Returns:RouteTargetList object
router_external

Get router-external for virtual-network.

Returns:xsd:boolean object
set_network_ipam(ref_obj, ref_data)

Set network-ipam for virtual-network.

Parameters:
  • ref_obj – NetworkIpam object
  • ref_data – VnSubnetsType object
set_network_ipam_list(ref_obj_list, ref_data_list)

Set network-ipam list for virtual-network.

Parameters:
  • ref_obj_list – list of NetworkIpam object
  • ref_data_list – list of VnSubnetsType object
set_network_policy(ref_obj, ref_data)

Set network-policy for virtual-network.

Parameters:
  • ref_obj – NetworkPolicy object
  • ref_data – VirtualNetworkPolicyType object
set_network_policy_list(ref_obj_list, ref_data_list)

Set network-policy list for virtual-network.

Parameters:
  • ref_obj_list – list of NetworkPolicy object
  • ref_data_list – list of VirtualNetworkPolicyType object
set_qos_config(ref_obj)

Set qos-config for virtual-network.

Parameters:ref_obj – QosConfig object
set_qos_config_list(ref_obj_list)

Set qos-config list for virtual-network.

Parameters:ref_obj_list – list of QosConfig object
set_route_table(ref_obj)

Set route-table for virtual-network.

Parameters:ref_obj – RouteTable object
set_route_table_list(ref_obj_list)

Set route-table list for virtual-network.

Parameters:ref_obj_list – list of RouteTable object
virtual_network_network_id

Get virtual-network-network-id for virtual-network.

Returns:xsd:integer object
virtual_network_properties

Get virtual-network-properties for virtual-network.

Returns:VirtualNetworkType object
class vnc_cfg_api_server.gen.resource_common.VirtualRouter(name=None, parent_obj=None, virtual_router_type=None, virtual_router_dpdk_enabled=None, virtual_router_ip_address=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents virtual-router configuration representation.

Child of:
GlobalSystemConfig object OR
Properties:
  • virtual_router_type

    Type: string, one-of [u’embedded’, u’tor-agent’, u’tor-service-node’]

    Created By: User (optional)

    Operations Allowed: CRD

    Description:

    Different types of the vrouters in the system.

  • virtual_router_dpdk_enabled

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This vrouter’s data path is using DPDK librarry, Virtual machines interfaces scheduled on this

    compute node will be tagged with aditional flags so that they are spawned with user space virtio

    driver. It is only applicable for embedded vrouter.

  • virtual_router_ip_address

    Type: string, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Ip address of the virtual router.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualMachine objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    References to all virtual machines on this vrouter. This link is not present for dynamically

    scheduled VMs by Nova.

Referred by:
add_virtual_machine(ref_obj)

Add virtual-machine to virtual-router.

Parameters:ref_obj – VirtualMachine object
display_name

Get display-name for virtual-router.

Returns:xsd:string object
dump()

Display virtual-router object in compact form.

get_fq_name()

Return FQN of virtual-router in list form.

get_fq_name_str()

Return FQN of virtual-router as colon delimited string.

get_parent_fq_name()

Return FQN of virtual-router’s parent in list form.

get_parent_fq_name_str()

Return FQN of virtual-router’s parent as colon delimted string.

get_physical_router_back_refs()

Return list of all physical-routers using this virtual-router

get_provider_attachment_back_refs()

Return list of all provider-attachments using this virtual-router

get_type()

Return object type (virtual-router).

get_virtual_machine_refs()

Return virtual-machine list for virtual-router.

Returns:list of <VirtualMachine>
id_perms

Get id-perms for virtual-router.

Returns:IdPermsType object
perms2

Get perms2 for virtual-router.

Returns:PermType2 object
set_virtual_machine(ref_obj)

Set virtual-machine for virtual-router.

Parameters:ref_obj – VirtualMachine object
set_virtual_machine_list(ref_obj_list)

Set virtual-machine list for virtual-router.

Parameters:ref_obj_list – list of VirtualMachine object
virtual_router_dpdk_enabled

Get virtual-router-dpdk-enabled for virtual-router.

Returns:xsd:boolean object
virtual_router_ip_address

Get virtual-router-ip-address for virtual-router.

Returns:IpAddressType object
virtual_router_type

Get virtual-router-type for virtual-router.

Returns:VirtualRouterType object

resource_xsd Module

This module defines the classes for types defined in vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.AclEntriesType(dynamic=None, acl_rule=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • dynamic

    Type: bool

    Created By: User (optional)

    Description:

    For Internal use only

  • acl_rule

    Type: AclRuleType

    Created By: User (required)

    Description:

    For Internal use only

class vnc_cfg_api_server.gen.resource_xsd.AclRuleType(match_condition=None, action_list=None, rule_uuid=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • match_condition

    Type: MatchConditionType

    Created By: User (required)

    Description:

    Match condition for packets

  • action_list

    Type: ActionListType

    Created By: User (required)

    Description:

    Actions to be performed if packets match condition

  • rule_uuid

    Type: string

    Created By: User (optional)

    Description:

    Rule UUID is identifier used in flow records to identify rule

class vnc_cfg_api_server.gen.resource_xsd.ActionCommunityType(add=None, remove=None, set=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

class vnc_cfg_api_server.gen.resource_xsd.ActionListType(simple_action=None, gateway_name=None, apply_service=None, mirror_to=None, assign_routing_instance=None, log=False, alert=False, qos_action=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • simple_action

    Type: string, one-of [u’deny’, u’pass’]

    Created By: User (required)

    Description:

    Simple allow(pass) or deny action for traffic matching this rule

  • gateway_name

    Type: string

    Created By: User (optional)

    Description:

    For internal use only

  • apply_service

    Type: string

    Created By: User (optional)

    Description:

    Ordered list of service instances in service chain applied to traffic matching

    the rule

  • mirror_to

    Type: MirrorActionType

    Created By: User (optional)

    Description:

    Mirror traffic matching this rule

  • assign_routing_instance

    Type: string

    Created By: User (optional)

    Description:

    For internal use only

  • log

    Type: bool

    Created By: User (optional)

    Description:

    Flow records for traffic matching this rule are sent at higher priority

  • alert

    Type: bool

    Created By: User (optional)

    Description:

    For internal use only

  • qos_action

    Type: string

    Created By: User (optional)

    Description:

    FQN of Qos configuration object for QoS marking

class vnc_cfg_api_server.gen.resource_xsd.ActionUpdateType(community=None, local_pref=None, med=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

class vnc_cfg_api_server.gen.resource_xsd.AddressFamilies(family=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • family

    Type: string, one-of [u’inet’, u’inet-vpn’, u’e-vpn’, u’erm-vpn’, u’route-target’, u’inet6’, u’inet6-vpn’]

    Description:

    BGP address families supported by contrail.

class vnc_cfg_api_server.gen.resource_xsd.AddressType(subnet=None, virtual_network=None, security_group=None, network_policy=None, subnet_list=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • subnet

    Type: SubnetType

    Created By: User (optional)

    Description:

    Any address that belongs to this subnet

  • virtual_network

    Type: string

    Created By: User (optional)

    Description:

    Any address that belongs to this virtul network

  • security_group

    Type: string

    Created By: User (optional)

    Description:

    Any address that belongs to interface with this security-group

  • network_policy

    Type: string

    Created By: User (optional)

    Description:

    Any adddress that belongs to virtul network which has this policy attached

  • subnet_list

    Type: SubnetType

    Created By: User (optional)

    Description:

    Any adddress that belongs to any one of subnet in this list

class vnc_cfg_api_server.gen.resource_xsd.AlarmAndList(and_list=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

class vnc_cfg_api_server.gen.resource_xsd.AlarmExpression(operation=None, operand1=None, operand2=None, vars=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • operation

    Type: string, one-of [u’==’, u’!=’, u’<=’, u’>=’, u’in’, u’not in’, u’size==’, u’size!=’]

    Created By: User (required)

    Description:

    operation to compare operand1 and operand2

  • operand1

    Type: string

    Created By: User (required)

    Description:

    UVE attribute specified in the dotted format. Example:

    NodeStatus.process_info.process_state

  • operand2

    Type: string

    Created By: User (required)

    Description:

    UVE attribute or a json value to compare with the UVE attribute in operand1.

    null value can be specified to check if operand1 exists using the operator != or

    ==

  • vars

    Type: string

    Created By: User (optional)

    Description:

    List of UVE attributes that would be useful when the alarm is raised. For

    example, user may want to raise an alarm if the

    NodeStatus.process_info.process_state != PROCESS_STATE_RUNNING. But, it would be

    useful to know the process_name whose state != PROCESS_STATE_RUNNING. This UVE

    attribute which is neither part of operand1 nor operand2 may be specified in

    vars

class vnc_cfg_api_server.gen.resource_xsd.AlarmOrList(or_list=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

class vnc_cfg_api_server.gen.resource_xsd.AllocationPoolType(start=None, end=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • start

    Type: string

  • end

    Type: string

class vnc_cfg_api_server.gen.resource_xsd.AllowedAddressPair(ip=None, mac=None, address_mode=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • ip

    Type: SubnetType

  • mac

    Type: string

    Created By: User (optional)

  • address_mode

    Type: string, one-of [u’active-active’, u’active-standby’]

    Created By: User (optional)

    Description:

    Address-mode active-backup is used for VRRP address.

    Address-mode active-active is used for ECMP.

class vnc_cfg_api_server.gen.resource_xsd.AllowedAddressPairs(allowed_address_pair=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

class vnc_cfg_api_server.gen.resource_xsd.ApiAccessListType(api_access=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

class vnc_cfg_api_server.gen.resource_xsd.ApiAccessType(api_name=None, permissions=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • api_name

    Type: string

    Created By: User (required)

  • permissions

    Type: PermType

    Created By: User (required)

class vnc_cfg_api_server.gen.resource_xsd.AttachmentAddressType(params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

class vnc_cfg_api_server.gen.resource_xsd.AttachmentInfoType(static=None, bgp=None, ospf=None, state=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

class vnc_cfg_api_server.gen.resource_xsd.AuthenticationData(key_type=None, key_items=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • key_type

    Type: string, one-of [u’md5’]

    Created By: User (required)

    Description:

    Authentication type for this session. Currently only MD5 is supported.

  • key_items

    Type: AuthenticationKeyItem

    Created By: User (required)

    Description:

    Upto two keys can be specified. Currently only one key is supported.

class vnc_cfg_api_server.gen.resource_xsd.AuthenticationKeyItem(key_id=None, key=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • key_id

    Type: int, within [0, 63]

  • key

    Type: string

class vnc_cfg_api_server.gen.resource_xsd.BgpFamilyAttributes(address_family=None, loop_count=0, prefix_limit=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • address_family

    Type: string, one-of [u’inet’, u’inet-vpn’, u’e-vpn’, u’erm-vpn’, u’route-target’, u’inet6’, u’inet6-vpn’]

    Created By: User (required)

    Description:

    Address family for which these parameters are applied.

  • loop_count

    Type: int, within [0, 16]

    Created By: User (optional)

    Description:

    For routing loop detection, loop-count is the number of times the local bgp-

    routers AS is allowed in the AS_PATH attribute.

  • prefix_limit

    Type: BgpPrefixLimit

    Created By: User (optional)

    Description:

    prefix-limit contains the maximum number of prefixes that are allowed to be

    received on the session for this address family.

class vnc_cfg_api_server.gen.resource_xsd.BgpPeeringAttributes(session=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • session

    Type: BgpSession

    Created By: User (required)

    Description:

    List of BGP sessions parameters. There can be multiple BGP sessions between two

    BGP routers. Currently ony 1 session is supported.

class vnc_cfg_api_server.gen.resource_xsd.BgpPrefixLimit(maximum=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • maximum

    Type: int

class vnc_cfg_api_server.gen.resource_xsd.BgpRouterParams(admin_down=False, vendor=None, autonomous_system=None, identifier=None, address=None, port=None, source_port=None, hold_time=0, address_families=None, auth_data=None, local_autonomous_system=None, router_type=None, gateway_address=None, ipv6_gateway_address=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • admin_down

    Type: bool

    Created By: User (optional)

    Description:

    Administratively up or down.

  • vendor

    Type: string

    Created By: User (optional)

    Description:

    Vendor name for this BGP router, contrail, juniper or cisco etc.

  • autonomous_system

    Type: int

    Created By: User (required)

    Description:

    Autonomus System number for this BGP router. Currently only 16 bit AS number is

    supported. For contrail control nodes this has to be equal to global AS number.

  • identifier

    Type: string, one-of xsd:string

    Created By: User (required)

    Description:

    Router ID for this BGP router. Dotted ip notation. For contrail control-nodes

    System will automatically assign value of address field.

  • address

    Type: string, one-of xsd:string

    Created By: User (required)

    Description:

    Ip addres used to reach this BGP router by the system.

  • port

    Type: int

    Created By: User (optional)

    Description:

    TCP port number on which BGP protocol connections are accepted. default is based

    on standareds.

  • source_port

    Type: int

    Description:

    For system internal use in BGPaaS service.

  • hold_time

    Type: int, within [0, 65535]

    Created By: User (optional)

    Description:

    BGP hold time in seconds [0-65535], Max time to detect liveliness to peer. Value

    0 will result in default value of 90 seconds

  • address_families

    Type: AddressFamilies

    Created By: User (optional)

    Description:

    BGP address families supported by BGP router

  • auth_data

    Type: AuthenticationData

    Created By: User (optional)

    Description:

    Authentication related configuration like type, keys etc.

  • local_autonomous_system

    Type: int

    Created By: User (optional)

    Description:

    Only for contrail control nodes, Autonomus System number if different then

    global AS number. Used when clusters of control nodes in same contrail system

    are in differnt locations. Currently only 16 bit AS number is supported.

  • router_type

    Type: string, one-of [u’control-node’, u’external-control-node’, u’router’, u’bgpaas-server’, u’bgpaas-client’]

    Created By: User (optional)

    Description:

    BGP router type.

  • gateway_address

    Type: string, one-of xsd:string

    Created By: User (optional)

    Description:

    gateway-address field is used only for router-type bgpaas-client. It holds the

    ipv4 gateway address for the ipv4 subnet from which the client has IP address.

    The value is used as nexthop when advertising routes to the client via bgp.

  • ipv6_gateway_address

    Type: string, one-of xsd:string

    Created By: User (optional)

    Description:

    The ipv6-gateway-addreess field is used only for router-type bgpaas-client. It

    holds ipv6 gateway address for ipv6 subnet from which the client has IP address.

    The value is used as nexthop when advertising routes to the client via bgp.

    Note that the ipv6-gateway-address can be a regular ipv6 address or a ipv4

    -mapped-ipv6 adddress.

class vnc_cfg_api_server.gen.resource_xsd.BgpSession(uuid=None, attributes=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • uuid

    Type: string

    Created By: User (required)

    Description:

    When multiple sessions are present, each session must have an unique id.

  • attributes

    Type: BgpSessionAttributes

    Created By: User (required)

    Description:

    There can be upto 3 instances BGP session attributes, representing configuration

    for both ends and common. Currently only 1 instance representing common

    attributes is supported.

class vnc_cfg_api_server.gen.resource_xsd.BgpSessionAttributes(bgp_router=None, admin_down=False, passive=False, as_override=False, hold_time=0, loop_count=0, address_families=None, auth_data=None, family_attributes=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • bgp_router

    Type: string

    Created By: User (optional)

    Description:

    When the parameters are uni-directional the bgp-router element specifies to

    which node the configuration applies. If missing the attributes apply to both

    ends of the session.

  • admin_down

    Type: bool

    Created By: User (optional)

    Description:

    Administratively mark this session down.

  • passive

    Type: bool

    Created By: User (optional)

    Description:

    This is passive session. It will not initiated connection. This is not relavent

    when session attributes represent common part. It is recomended that it should

    not be set to true in current release.

  • as_override

    Type: bool

    Created By: User (optional)

    Description:

    To Be Added

  • hold_time

    Type: int, within [0, 65535]

    Created By: User (optional)

    Description:

    A non-zero hold-time overrides the hold-time inherited from the bgp-router

    configuration. BGP hold time in seconds [0-65535], Max time to detect liveliness

    of peer.

  • loop_count

    Type: int, within [0, 16]

    Created By: User (optional)

    Description:

    For routing loop detection, loop-count is the number of times the local bgp-

    routers AS is allowed in the AS_PATH attribute.

  • address_families

    Type: AddressFamilies

    Created By: User (optional)

    Description:

    BGP address families supported on this session.

  • auth_data

    Type: AuthenticationData

    Created By: User (optional)

    Description:

    Authentication related configuration for this session like type, keys etc.

  • family_attributes

    Type: BgpFamilyAttributes

    Created By: User (optional)

    Description:

    Session attributes over ride per BGP address family. Attributes like address

    family, loop-count and prefix-limit.

class vnc_cfg_api_server.gen.resource_xsd.BindingType(params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

class vnc_cfg_api_server.gen.resource_xsd.CommunityAttributes(community_attribute=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • community_attribute

    Type: string, one-of xsd:string

    Description:

    List of Community attributes, it indicates the attributes with which the routes

    are tagged while publishing.

    The attributes will be represented as bgp community in the path attribute.

    Each attribute is indicated as string.

    1. String with two integers separated by ”:”. E.g. “64512:123”

    2. Well-known community as string.

      Possible values are “no-export” “accept-own” “no-advertise” “no-export-

    subconfed” “no-reoriginate”

class vnc_cfg_api_server.gen.resource_xsd.CommunityListType(community=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • community

    Type: string, one-of xsd:string

    Description:

    List of Community attributes, it indicates the attributes with which the routes

    are tagged while publishing.

    The attributes will be represented as bgp community in the path attribute.

    Each attribute is indicated as string.

    1. String with two integers separated by ”:”. E.g. “64512:123”

    2. Well-known community as string.

      Possible values are “no-export” “accept-own” “no-advertise” “no-export-

    subconfed” “no-reoriginate”

class vnc_cfg_api_server.gen.resource_xsd.ConnectionType(destination_instance=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • destination_instance

    Type: string

class vnc_cfg_api_server.gen.resource_xsd.DefaultProtocolType(bgp=None, ospf=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

class vnc_cfg_api_server.gen.resource_xsd.DhcpOptionType(dhcp_option_name=None, dhcp_option_value=None, dhcp_option_value_bytes=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • dhcp_option_name

    Type: string

    Created By: User (required)

    Description:

    Name of the DHCP option

  • dhcp_option_value

    Type: string

    Created By: User (required)

    Description:

    Encoded DHCP option value (decimal)

  • dhcp_option_value_bytes

    Type: string

    Created By: User (required)

    Description:

    Value of the DHCP option to be copied byte by byte

class vnc_cfg_api_server.gen.resource_xsd.DhcpOptionsListType(dhcp_option=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

class vnc_cfg_api_server.gen.resource_xsd.DiscoveryPubSubEndPointType(ep_type=None, ep_id=None, ep_prefix=None, ep_version=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • ep_type

    Type: string

    Created By: User (required)

  • ep_id

    Type: string

    Created By: User (optional)

    Description:

    Specific service or client which is set of one.

  • ep_prefix

    Type: SubnetType

    Created By: User (optional)

    Description:

    All servers or clients whose ip match this prefix

  • ep_version

    Type: string

    Created By: User (optional)

    Description:

    All servers or clients whose version match this version

class vnc_cfg_api_server.gen.resource_xsd.DiscoveryServiceAssignmentType(publisher=None, subscriber=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

class vnc_cfg_api_server.gen.resource_xsd.DomainLimitsType(project_limit=None, virtual_network_limit=None, security_group_limit=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • project_limit

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of projects allowed in this domian

  • virtual_network_limit

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of virtual networks allowed in this domian

  • security_group_limit

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of security groups allowed in this domian

class vnc_cfg_api_server.gen.resource_xsd.EcmpHashingIncludeFields(hashing_configured=False, source_ip=True, destination_ip=True, ip_protocol=True, source_port=True, destination_port=True, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • hashing_configured

    Type: bool

    Created By: User (optional)

    Description:

    When True, Packet header fields used in calculating ECMP hash is decided by

    following flags

  • source_ip

    Type: bool

    Created By: User (optional)

    Description:

    When false, do not use source ip in the ECMP hash calculation

  • destination_ip

    Type: bool

    Created By: User (optional)

    Description:

    When false, do not use destination ip in the ECMP hash calculation

  • ip_protocol

    Type: bool

    Created By: User (optional)

    Description:

    When false, do not use ip protocol in the ECMP hash calculation

  • source_port

    Type: bool

    Created By: User (optional)

    Description:

    When false, do not use source port in the ECMP hash calculation

  • destination_port

    Type: bool

    Created By: User (optional)

    Description:

    When false, do not use destination port in the ECMP hash calculation

class vnc_cfg_api_server.gen.resource_xsd.EncapsulationPrioritiesType(encapsulation=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • encapsulation

    Type: string, one-of [u’MPLSoGRE’, u’MPLSoUDP’, u’VXLAN’]

    Created By: User (optional)

    Description:

    Ordered list of encapsulation types to be used in priority

class vnc_cfg_api_server.gen.resource_xsd.FatFlowProtocols(fat_flow_protocol=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

class vnc_cfg_api_server.gen.resource_xsd.FloatingIpPoolType(subnet=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • subnet

    Type: SubnetType

    Created By: User (optional)

    Description:

    Block of ipaddresses for floating ip allocation. Currently not supported

class vnc_cfg_api_server.gen.resource_xsd.FlowAgingTimeout(protocol=None, port=None, timeout_in_seconds=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • protocol

    Type: string

  • port

    Type: int

  • timeout_in_seconds

    Type: int

class vnc_cfg_api_server.gen.resource_xsd.FlowAgingTimeoutList(flow_aging_timeout=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • flow_aging_timeout

    Type: FlowAgingTimeout

    Created By: User (optional)

    Description:

    List of (ip protocol, port number, timeout in seconds)

class vnc_cfg_api_server.gen.resource_xsd.GracefulRestartType(graceful_restart_time=0, long_lived_graceful_restart_time=0, end_of_rib_receive_time=30, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • graceful_restart_time

    Type: int, within [0, 4095]

  • long_lived_graceful_restart_time

    Type: int, within [0, 16777215]

  • end_of_rib_receive_time

    Type: int, within [0, 4095]

class vnc_cfg_api_server.gen.resource_xsd.IdPermsType(permissions=None, uuid=None, enable=None, created=None, last_modified=None, description=None, user_visible=True, creator=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • permissions

    Type: PermType

    Created By: User (optional)

    Description:

    No longer used, will be removed

  • uuid

    Type: UuidType

    Created By: User (required)

    Description:

    UUID of the object, system automatically allocates one if not provided

  • enable

    Type: bool

    Created By: User (required)

    Description:

    Administratively Enable/Disable this object

  • created

    Type: xsd:dateTime

    Description:

    Time when this object was created

  • last_modified

    Type: xsd:dateTime

    Description:

    Time when this object was created

  • description

    Type: string

    Created By: User (optional)

    Description:

    User provided text

  • user_visible

    Type: bool

    Description:

    System created internal objects will have this flag set and will not be visible

  • creator

    Type: string

    Description:

    Id of tenant who created this object

class vnc_cfg_api_server.gen.resource_xsd.InstanceTargetType(import_export=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • import_export

    Type: string, one-of [u’import’, u’export’]

class vnc_cfg_api_server.gen.resource_xsd.InterfaceMirrorType(traffic_direction=None, mirror_to=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • traffic_direction

    Type: string, one-of [u’ingress’, u’egress’, u’both’]

    Created By: User (required)

    Description:

    Specifies direction of traffic to mirror, Ingress, Egress or both

  • mirror_to

    Type: MirrorActionType

    Created By: User (required)

    Description:

    Mirror destination configuration

class vnc_cfg_api_server.gen.resource_xsd.IpAddressesType(ip_address=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • ip_address

    Type: string, one-of xsd:string

    Description:

    String of standard notation of ipv4 or ipv6 address

class vnc_cfg_api_server.gen.resource_xsd.IpamDnsAddressType(tenant_dns_server_address=None, virtual_dns_server_name=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • tenant_dns_server_address

    Type: IpAddressesType

    Created By: User (optional)

    Description:

    In case of tenant DNS server method, Ip address of DNS server. This will be

    given in DHCP

  • virtual_dns_server_name

    Type: string

    Created By: User (optional)

    Description:

    In case of virtual DNS server, name of virtual DNS server

class vnc_cfg_api_server.gen.resource_xsd.IpamSubnetType(subnet=None, default_gateway=None, dns_server_address=None, subnet_uuid=None, enable_dhcp=True, dns_nameservers=None, allocation_pools=None, addr_from_start=None, dhcp_option_list=None, host_routes=None, subnet_name=None, alloc_unit=1, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • subnet

    Type: SubnetType

    Created By: User (required)

    Description:

    ip prefix and length for the subnet

  • default_gateway

    Type: string, one-of xsd:string

    Created By: User (optional)

    Description:

    default-gateway ip address in the subnet, if not provided one is auto generated

    by the system.

  • dns_server_address

    Type: string, one-of xsd:string

    Created By: User (optional)

    Description:

    DNS server ip address in the subnet, if not provided one is auto generated by

    the system.

  • subnet_uuid

    Type: string

    Description:

    Subnet UUID is auto generated by the system

  • enable_dhcp

    Type: bool

    Created By: User (optional)

    Description:

    Enable DHCP for the VM(s) in this subnet

  • dns_nameservers

    Type: string

    Created By: User (optional)

    Description:

    Tenant DNS servers ip address in tenant DNS method

  • allocation_pools

    Type: AllocationPoolType

    Created By: User (optional)

    Description:

    List of ranges of ip address within the subnet from which to allocate ip

    address. default is entire prefix

  • addr_from_start

    Type: bool

    Created By: User (optional)

    Description:

    Start address allocation from start or from end of address range.

  • dhcp_option_list

    Type: DhcpOptionsListType

    Created By: User (optional)

    Description:

    DHCP options list to be sent via DHCP for VM(s) in this subnet

  • host_routes

    Type: RouteTableType

    Created By: User (optional)

    Description:

    Host routes to be sent via DHCP for VM(s) in this subnet, Next hop for these

    routes is always default gateway

  • subnet_name

    Type: string

    Created By: User (optional)

    Description:

    User provided name for this subnet

  • alloc_unit

    Type: int

    Created By: User (optional)

    Description:

    allocation unit for this subnet to allocate bulk ip addresses

class vnc_cfg_api_server.gen.resource_xsd.IpamSubnets(subnets=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

class vnc_cfg_api_server.gen.resource_xsd.IpamType(ipam_method=None, ipam_dns_method=None, ipam_dns_server=None, dhcp_option_list=None, cidr_block=None, host_routes=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • ipam_method

    Type: string, one-of [u’dhcp’, u’fixed’]

    Created By: User (optional)

  • ipam_dns_method

    Type: string, one-of [u’none’, u’default-dns-server’, u’tenant-dns-server’, u’virtual-dns-server’]

    Created By: User (optional)

  • ipam_dns_server

    Type: IpamDnsAddressType

    Created By: User (optional)

  • dhcp_option_list

    Type: DhcpOptionsListType

    Created By: User (optional)

  • cidr_block

    Type: SubnetType

    Created By: User (optional)

  • host_routes

    Type: RouteTableType

    Created By: User (optional)

class vnc_cfg_api_server.gen.resource_xsd.JunosServicePorts(service_port=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • service_port

    Type: string

class vnc_cfg_api_server.gen.resource_xsd.KeyValuePair(key=None, value=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • key

    Type: string

  • value

    Type: string

class vnc_cfg_api_server.gen.resource_xsd.KeyValuePairs(key_value_pair=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

class vnc_cfg_api_server.gen.resource_xsd.LinklocalServiceEntryType(linklocal_service_name=None, linklocal_service_ip=None, linklocal_service_port=None, ip_fabric_DNS_service_name=None, ip_fabric_service_port=None, ip_fabric_service_ip=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • linklocal_service_name

    Type: string

    Created By: User (required)

    Description:

    Name of the link local service. VM name resolution of this name will result in

    link local ip address

  • linklocal_service_ip

    Type: string, one-of xsd:string

    Created By: User (required)

    Description:

    ip address of the link local service.

  • linklocal_service_port

    Type: int

    Created By: User (required)

    Description:

    Destination TCP port number of link local service

  • ip_fabric_DNS_service_name

    Type: string

    Created By: User (optional)

    Description:

    DNS name to which link local service will be proxied

  • ip_fabric_service_port

    Type: int

    Created By: User (required)

    Description:

    Destination TCP port number to which link local traffic will forwarded

  • ip_fabric_service_ip

    Type: string, one-of xsd:string

    Created By: User (optional)

    Description:

    Destination ip address to which link local traffic will forwarded

class vnc_cfg_api_server.gen.resource_xsd.LinklocalServicesTypes(linklocal_service_entry=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • linklocal_service_entry

    Type: LinklocalServiceEntryType

    Created By: User (optional)

    Description:

    List of link local services

class vnc_cfg_api_server.gen.resource_xsd.LoadbalancerHealthmonitorType(admin_state=True, monitor_type=None, delay=None, timeout=None, max_retries=None, http_method=None, url_path=None, expected_codes=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • admin_state

    Type: bool

    Created By: User (optional)

    Description:

    Administratively up or dowm.

  • monitor_type

    Type: string, one-of [u’PING’, u’TCP’, u’HTTP’, u’HTTPS’]

    Created By: User (required)

    Description:

    Protocol used to monitor health, PING, HTTP, HTTPS or TCP

  • delay

    Type: int

    Created By: User (required)

    Description:

    Time in seconds at which health check is repeated

  • timeout

    Type: int

    Created By: User (required)

    Description:

    Time in seconds to wait for response

  • max_retries

    Type: int

    Created By: User (required)

    Description:

    Number of failures before declaring health bad

  • http_method

    Type: string

    Created By: User (optional)

    Description:

    In case monitor protocol is HTTP, type of http method used like GET, PUT, POST

    etc

  • url_path

    Type: string

    Created By: User (optional)

    Description:

    In case monitor protocol is HTTP, URL to be used. In case of ICMP, ip address

  • expected_codes

    Type: string

    Created By: User (optional)

    Description:

    In case monitor protocol is HTTP, expected return code for HTTP operations like

    200 ok.

class vnc_cfg_api_server.gen.resource_xsd.LoadbalancerListenerType(protocol=None, protocol_port=None, admin_state=True, connection_limit=None, default_tls_container=None, sni_containers=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • protocol

    Type: string, one-of [u’HTTP’, u’HTTPS’, u’TCP’, u’TERMINATED_HTTPS’]

  • protocol_port

    Type: int

  • admin_state

    Type: bool

  • connection_limit

    Type: int

  • default_tls_container

    Type: string

  • sni_containers

    Type: string

class vnc_cfg_api_server.gen.resource_xsd.LoadbalancerMemberType(admin_state=True, status=None, status_description=None, protocol_port=None, weight=None, address=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • admin_state

    Type: bool

    Created By: User (optional)

    Description:

    Administrative up or down.

  • status

    Type: string

    Description:

    Operational status of the member.

  • status_description

    Type: string

    Description:

    Operational status description of the member.

  • protocol_port

    Type: int

    Created By: User (optional)

    Description:

    Destination port for the application on the member.

  • weight

    Type: int

    Created By: User (optional)

    Description:

    Weight for load balancing

  • address

    Type: string, one-of xsd:string

    Created By: User (optional)

    Description:

    Ip address of the member

class vnc_cfg_api_server.gen.resource_xsd.LoadbalancerPoolType(status=None, status_description=None, admin_state=True, protocol=None, loadbalancer_method=None, subnet_id=None, session_persistence=None, persistence_cookie_name=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • status

    Type: string

    Description:

    Operating status for this loadbalancer pool.

  • status_description

    Type: string

    Description:

    Operating status description for this loadbalancer pool.

  • admin_state

    Type: bool

    Created By: User (optional)

    Description:

    Administrative up or down

  • protocol

    Type: string, one-of [u’HTTP’, u’HTTPS’, u’TCP’, u’TERMINATED_HTTPS’]

    Created By: User (optional)

    Description:

    IP protocol string like http, https or tcp.

  • loadbalancer_method

    Type: string, one-of [u’ROUND_ROBIN’, u’LEAST_CONNECTIONS’, u’SOURCE_IP’]

    Created By: User (optional)

    Description:

    Load balancing method ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP

  • subnet_id

    Type: string, one-of xsd:string

    Created By: User (optional)

    Description:

    UUID of the subnet from where the members of the pool are reachable.

  • session_persistence

    Type: string, one-of [u’SOURCE_IP’, u’HTTP_COOKIE’, u’APP_COOKIE’]

    Created By: User (optional)

    Description:

    Method for persistence. HTTP_COOKIE, SOURCE_IP or APP_COOKIE.

  • persistence_cookie_name

    Type: string

    Created By: User (optional)

    Description:

    To Be Added

class vnc_cfg_api_server.gen.resource_xsd.LoadbalancerType(status=None, provisioning_status=None, operating_status=None, vip_subnet_id=None, vip_address=None, admin_state=True, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • status

    Type: string

    Created By: User (optional)

    Description:

    Operational status of the load balancer updated by system.

  • provisioning_status

    Type: string

    Created By: User (optional)

    Description:

    Provisioning status of the load balancer updated by system.

  • operating_status

    Type: string

    Created By: User (optional)

    Description:

    Operational status of the load balancer updated by system.

  • vip_subnet_id

    Type: string, one-of xsd:string

    Created By: User (optional)

    Description:

    Subnet UUID of the subnet of VIP, representing virtual network.

  • vip_address

    Type: string, one-of xsd:string

    Created By: User (optional)

    Description:

    Virtual ip for this LBaaS

  • admin_state

    Type: bool

    Created By: User (optional)

    Description:

    Administrative up or down

class vnc_cfg_api_server.gen.resource_xsd.MacAddressesType(mac_address=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • mac_address

    Type: None

class vnc_cfg_api_server.gen.resource_xsd.MatchConditionType(protocol=None, src_address=None, src_port=None, dst_address=None, dst_port=None, ethertype=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • protocol

    Type: string

    Created By: User (required)

    Description:

    Layer 4 protocol in ip packet

  • src_address

    Type: AddressType

    Created By: User (required)

    Description:

    Source ip matching criteria

  • src_port

    Type: PortType

    Created By: User (required)

    Description:

    Range of source port for layer 4 protocol

  • dst_address

    Type: AddressType

    Created By: User (required)

    Description:

    Destination ip matching criteria

  • dst_port

    Type: PortType

    Created By: User (required)

    Description:

    Range of destination port for layer 4 protocol

  • ethertype

    Type: string, one-of [u’IPv4’, u’IPv6’]

    Created By: User (required)

class vnc_cfg_api_server.gen.resource_xsd.MirrorActionType(analyzer_name=None, encapsulation=None, analyzer_ip_address=None, analyzer_mac_address=None, routing_instance=None, udp_port=None, juniper_header=True, nh_mode=None, static_nh_header=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • analyzer_name

    Type: string

    Created By: User (optional)

    Description:

    Name of service instance used as analyzer

  • encapsulation

    Type: string

    Created By: User (optional)

    Description:

    Encapsulation for Mirrored packet, not used currently

  • analyzer_ip_address

    Type: string, one-of xsd:string

    Created By: User (required)

    Description:

    ip address of interface to which mirrored packets are sent

  • analyzer_mac_address

    Type: string

    Created By: User (optional)

    Description:

    mac address of interface to which mirrored packets are sent

  • routing_instance

    Type: string

    Created By: User (required)

    Description:

    Internal use only, should be set to -1

  • udp_port

    Type: int

    Created By: User (optional)

    Description:

    ip udp port used in contrail default encapsulation for mirroring

  • juniper_header

    Type: bool

    Created By: User (optional)

    Description:

    This flag is used to determine with/without juniper-header

  • nh_mode

    Type: string, one-of [u’dynamic’, u’static’]

    Created By: User (optional)

    Description:

    This mode used to determine static or dynamic nh

  • static_nh_header

    Type: StaticMirrorNhType

    Created By: User (optional)

    Description:

    vtep details required if static nh enabled

class vnc_cfg_api_server.gen.resource_xsd.PermType(owner=None, owner_access=None, group=None, group_access=None, other_access=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • owner

    Type: string

  • owner_access

    Type: int, within [0, 7]

    Description:

    Three bits representing rwx.

    r=read permission,

    w=write permission,

    x=reference permission

  • group

    Type: string

  • group_access

    Type: int, within [0, 7]

    Description:

    Three bits representing rwx.

    r=read permission,

    w=write permission,

    x=reference permission

  • other_access

    Type: int, within [0, 7]

    Description:

    Three bits representing rwx.

    r=read permission,

    w=write permission,

    x=reference permission

class vnc_cfg_api_server.gen.resource_xsd.PermType2(owner=None, owner_access=None, global_access=None, share=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • owner

    Type: string

    Created By: User (required)

    Description:

    Owner tenant of the object

  • owner_access

    Type: int, within [0, 7]

    Created By: User (required)

    Description:

    Owner permissions of the object

  • global_access

    Type: int, within [0, 7]

    Created By: User (optional)

    Description:

    Globally(others) shared object and permissions for others of the object

  • share

    Type: ShareType

    Created By: User (optional)

    Description:

    Selectively shared object, List of (tenant, permissions)

class vnc_cfg_api_server.gen.resource_xsd.PluginProperties(plugin_property=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • plugin_property

    Type: PluginProperty

    Created By: User (optional)

    Description:

    List of plugin specific properties (property, value)

class vnc_cfg_api_server.gen.resource_xsd.PluginProperty(property=None, value=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • property

    Type: string

  • value

    Type: string

class vnc_cfg_api_server.gen.resource_xsd.PolicyBasedForwardingRuleType(direction=None, vlan_tag=None, src_mac=None, dst_mac=None, mpls_label=None, service_chain_address=None, ipv6_service_chain_address=None, protocol=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • direction

    Type: string, one-of [u’ingress’, u’egress’, u’both’]

  • vlan_tag

    Type: int

  • src_mac

    Type: string

  • dst_mac

    Type: string

  • mpls_label

    Type: int

  • service_chain_address

    Type: string, one-of xsd:string

  • ipv6_service_chain_address

    Type: string, one-of xsd:string

    Description:

    String of standard notation of ipv4 or ipv6 address

  • protocol

    Type: string

class vnc_cfg_api_server.gen.resource_xsd.PolicyEntriesType(policy_rule=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • policy_rule

    Type: PolicyRuleType

    Created By: User (required)

    Description:

    List of policy rules

class vnc_cfg_api_server.gen.resource_xsd.PolicyRuleType(rule_sequence=None, rule_uuid=None, direction=None, protocol=None, src_addresses=None, src_ports=None, application=None, dst_addresses=None, dst_ports=None, action_list=None, ethertype=None, params_dict=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

  • rule_sequence

    Type: SequenceType

    Created By: User (optional)

    Description:

    Deprecated, Will be removed

  • rule_uuid

    Type: string

    Created By: User (optional)

    Description:

    Rule UUID is identifier used in flow records to identify rule

  • direction

    Type: string, one-of [u’>’, u’<>’]

    Created By: User (required)

  • protocol

    Type: string

    Created By: User (required)

    Description:

    Layer 4 protocol in ip packet

  • src_addresses

    Type: AddressType

    Created By: User (required)

    Description:

    Source ip matching criteria

  • src_ports

    Type: PortType

    Created By: User (required)

    Description:

    Range of source port for layer 4 protocol

  • application

    Type: string

    Created By: User (optional)

    Description:

    Optionally application can be specified instead of protcol and port. not

    currently implemented

  • dst_addresses

    Type: