Library API reference

resource_common Module

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

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

Bases: future.types.newobject.newobject

When parent is virtual-network:
Virtual network access control list are automatically derived from all the network policies attached to virtual network.
When parent is security-group:
port access control list is automatically derived from all the security groups attached to port.
Created By:
System when parent is VirtualNetwork System when parent is SecurityGroup
Child of:
VirtualNetwork object OR SecurityGroup object
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.

  • access_control_list_hash

    Type: int

    Created By: System

    Operations Allowed: CRUD

    Description:

    A hash value of all the access-control-list-entries in this ACL objects automatically generated by

    system.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

access_control_list_entries

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

Returns:AclEntriesType object
access_control_list_hash

Get access-control-list-hash for access-control-list.

Returns:xsd:unsignedLong object
add_tag(ref_obj)

Add tag to access-control-list.

Parameters:ref_obj – Tag object
annotations

Get annotations for access-control-list.

Returns:KeyValuePairs 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_tag_refs()

Return tag list for access-control-list.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for access-control-list.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for access-control-list.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.AddressGroup(name=None, parent_obj=None, draft_mode_state=None, address_group_prefix=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

When parent is policy-management:
Address Group object
When parent is project:
Project level address Group object
Created By:
User when parent is PolicyManagement User when parent is Project
Child of:
PolicyManagement object OR Project object
Properties:
  • draft_mode_state

    Type: str, one-of [u’created’, u’updated’, u’deleted’]

    Created By: User (optional)

    Operations Allowed: R

    Description:

  • address_group_prefix

    Type: SubnetListType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of IP prefix

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to address-group.

Parameters:ref_obj – Tag object
address_group_prefix

Get address-group-prefix for address-group.

Returns:SubnetListType object
annotations

Get annotations for address-group.

Returns:KeyValuePairs object
display_name

Get display-name for address-group.

Returns:xsd:string object
draft_mode_state

Get draft-mode-state for address-group.

Returns:DraftModeState object
dump()

Display address-group object in compact form.

get_firewall_rule_back_refs()

Return list of all firewall-rules using this address-group

get_fq_name()

Return FQN of address-group in list form.

get_fq_name_str()

Return FQN of address-group as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for address-group.

Returns:list of <Tag>
get_type()

Return object type (address-group).

id_perms

Get id-perms for address-group.

Returns:IdPermsType object
perms2

Get perms2 for address-group.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for address-group.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for address-group.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.Alarm(name=None, parent_obj=None, uve_keys=None, alarm_severity=None, alarm_rules=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

When parent is global-system-config:
List of alarms that are applicable to objects anchored under global-system-config.
When parent is project:
List of alarms that are applicable to objects anchored under the project.
Created By:
User when parent is GlobalSystemConfig User when parent is Project
Child of:
GlobalSystemConfig object OR Project object
Properties:
  • uve_keys

    Type: UveKeysType

    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 or specific uve objects such as

    analytics-node, config-node, control-node:<hostname>, etc.,

  • alarm_severity

    Type: int, within [0, 2]

    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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to alarm.

Parameters:ref_obj – Tag object
alarm_rules

Get alarm-rules for alarm.

Returns:AlarmOrList object
alarm_severity

Get alarm-severity for alarm.

Returns:AlarmSeverity object
annotations

Get annotations for alarm.

Returns:KeyValuePairs 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_tag_refs()

Return tag list for alarm.

Returns:list of <Tag>
get_type()

Return object type (alarm).

id_perms

Get id-perms for alarm.

Returns:IdPermsType object
perms2

Get perms2 for alarm.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for alarm.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for alarm.

Parameters:ref_obj_list – list of Tag object
uve_keys

Get uve-keys for alarm.

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

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
AliasIpPool object
Properties:
  • alias_ip_address

    Type: str, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CR

    Description:

    Alias ip address.

  • alias_ip_address_family

    Type: str, 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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_project(ref_obj)

Add project to alias-ip.

Parameters:ref_obj – Project object
add_tag(ref_obj)

Add tag to alias-ip.

Parameters:ref_obj – Tag 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
annotations

Get annotations for alias-ip.

Returns:KeyValuePairs 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_tag_refs()

Return tag list for alias-ip.

Returns:list of <Tag>
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_tag(ref_obj)

Set tag for alias-ip.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for alias-ip.

Parameters:ref_obj_list – list of Tag 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 gen.resource_common.AliasIpPool(name=None, parent_obj=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
VirtualNetwork object
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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:
  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to alias-ip-pool.

Parameters:ref_obj – Tag object
annotations

Get annotations for alias-ip-pool.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for alias-ip-pool.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for alias-ip-pool.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for alias-ip-pool.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.AnalyticsAlarmNode(name=None, parent_obj=None, analytics_alarm_node_ip_address=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • analytics_alarm_node_ip_address

    Type: str, one-of xsd:string

    Created By: User (admin-only)

    Operations Allowed: CRUD

    Description:

    Ip address of the analytics alarm node, set while provisioning.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to analytics-alarm-node.

Parameters:ref_obj – Tag object
analytics_alarm_node_ip_address

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

Returns:IpAddressType object
annotations

Get annotations for analytics-alarm-node.

Returns:KeyValuePairs object
display_name

Get display-name for analytics-alarm-node.

Returns:xsd:string object
dump()

Display analytics-alarm-node object in compact form.

get_fq_name()

Return FQN of analytics-alarm-node in list form.

get_fq_name_str()

Return FQN of analytics-alarm-node as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for analytics-alarm-node.

Returns:list of <Tag>
get_type()

Return object type (analytics-alarm-node).

id_perms

Get id-perms for analytics-alarm-node.

Returns:IdPermsType object
perms2

Get perms2 for analytics-alarm-node.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for analytics-alarm-node.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for analytics-alarm-node.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.AnalyticsNode(name=None, parent_obj=None, analytics_node_ip_address=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • analytics_node_ip_address

    Type: str, 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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to analytics-node.

Parameters:ref_obj – Tag object
analytics_node_ip_address

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

Returns:IpAddressType object
annotations

Get annotations for analytics-node.

Returns:KeyValuePairs 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_tag_refs()

Return tag list for analytics-node.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for analytics-node.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for analytics-node.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.AnalyticsSnmpNode(name=None, parent_obj=None, analytics_snmp_node_ip_address=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • analytics_snmp_node_ip_address

    Type: str, one-of xsd:string

    Created By: User (admin-only)

    Operations Allowed: CRUD

    Description:

    Ip address of the analytics snmp node, set while provisioning.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to analytics-snmp-node.

Parameters:ref_obj – Tag object
analytics_snmp_node_ip_address

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

Returns:IpAddressType object
annotations

Get annotations for analytics-snmp-node.

Returns:KeyValuePairs object
display_name

Get display-name for analytics-snmp-node.

Returns:xsd:string object
dump()

Display analytics-snmp-node object in compact form.

get_fq_name()

Return FQN of analytics-snmp-node in list form.

get_fq_name_str()

Return FQN of analytics-snmp-node as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for analytics-snmp-node.

Returns:list of <Tag>
get_type()

Return object type (analytics-snmp-node).

id_perms

Get id-perms for analytics-snmp-node.

Returns:IdPermsType object
perms2

Get perms2 for analytics-snmp-node.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for analytics-snmp-node.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for analytics-snmp-node.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.ApiAccessList(name=None, parent_obj=None, api_access_list_entries=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

When parent is domain:
API access list is list of rules that define role based access to each API and its properties at domain level.
When parent is project:
API access list is list of rules that define role based access to each API and its properties at project level.
When parent is global-system-config:
Global API access list applicable to all domain and projects
Created By:
User when parent is Domain User when parent is Project User when parent is GlobalSystemConfig
Child of:
Domain object OR Project object OR GlobalSystemConfig object
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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to api-access-list.

Parameters:ref_obj – Tag object
annotations

Get annotations for api-access-list.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for api-access-list.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for api-access-list.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for api-access-list.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.ApplicationPolicySet(name=None, parent_obj=None, draft_mode_state=None, all_applications=False, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

When parent is policy-management:
Application-policy object defining policies to apply for a given application tag
When parent is project:
Project level application-policy object defining policies to apply for a given application tag
Created By:
User when parent is PolicyManagement User when parent is Project
Child of:
PolicyManagement object OR Project object
Properties:
  • draft_mode_state

    Type: str, one-of [u’created’, u’updated’, u’deleted’]

    Created By: User (optional)

    Operations Allowed: R

    Description:

  • all_applications

    Type: bool

    Created By: User (optional)

    Operations Allowed: R

    Description:

    If set, indicates application policy set to be applied to all application tags

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 (FirewallPolicy object, FirewallSequence attribute)

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Reference to firewall-policy attached to this application-policy

  • list of GlobalVrouterConfig objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Reference to global-vrouter-config is automatically created by system for global

    application policy sets

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_firewall_policy(ref_obj, ref_data=None)

Add firewall-policy to application-policy-set.

Parameters:
  • ref_obj – FirewallPolicy object
  • ref_data – FirewallSequence object
add_global_vrouter_config(ref_obj)

Add global-vrouter-config to application-policy-set.

Parameters:ref_obj – GlobalVrouterConfig object
add_tag(ref_obj)

Add tag to application-policy-set.

Parameters:ref_obj – Tag object
all_applications

Get all-applications for application-policy-set.

Returns:xsd:boolean object
annotations

Get annotations for application-policy-set.

Returns:KeyValuePairs object
display_name

Get display-name for application-policy-set.

Returns:xsd:string object
draft_mode_state

Get draft-mode-state for application-policy-set.

Returns:DraftModeState object
dump()

Display application-policy-set object in compact form.

get_firewall_policy_refs()

Return firewall-policy list for application-policy-set.

Returns:list of tuple <FirewallPolicy, FirewallSequence>
get_fq_name()

Return FQN of application-policy-set in list form.

get_fq_name_str()

Return FQN of application-policy-set as colon delimited string.

get_global_vrouter_config_refs()

Return global-vrouter-config list for application-policy-set.

Returns:list of <GlobalVrouterConfig>
get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_project_back_refs()

Return list of all projects using this application-policy-set

get_tag_refs()

Return tag list for application-policy-set.

Returns:list of <Tag>
get_type()

Return object type (application-policy-set).

id_perms

Get id-perms for application-policy-set.

Returns:IdPermsType object
perms2

Get perms2 for application-policy-set.

Returns:PermType2 object
set_firewall_policy(ref_obj, ref_data=None)

Set firewall-policy for application-policy-set.

Parameters:
  • ref_obj – FirewallPolicy object
  • ref_data – FirewallSequence object
set_firewall_policy_list(ref_obj_list, ref_data_list=None)

Set firewall-policy list for application-policy-set.

Parameters:
  • ref_obj_list – list of FirewallPolicy object
  • ref_data_list – list of FirewallSequence object
set_global_vrouter_config(ref_obj)

Set global-vrouter-config for application-policy-set.

Parameters:ref_obj – GlobalVrouterConfig object
set_global_vrouter_config_list(ref_obj_list)

Set global-vrouter-config list for application-policy-set.

Parameters:ref_obj_list – list of GlobalVrouterConfig object
set_tag(ref_obj)

Set tag for application-policy-set.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for application-policy-set.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.BgpAsAService(name=None, parent_obj=None, autonomous_system=None, bgpaas_shared=False, bgpaas_ip_address=None, bgpaas_session_attributes=None, bgpaas_ipv4_mapped_ipv6_nexthop=None, bgpaas_suppress_route_advertisement=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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.

Created By:
User
Child of:
Project object
Properties:
  • autonomous_system

    Type: int, within [1, 4294967295]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Autonomous System number for the cluster which is 16 bits by default, but can be changed to 32 bits

    by setting enable-4byte-as.

  • bgpaas_shared

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    True if only one BGP router needs to be created. Otherwise, one BGP router is created for each VMI

  • bgpaas_ip_address

    Type: str, 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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 (ControlNodeZone object, BGPaaSControlNodeZoneAttributes attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to control-node-zone for bgp-peer selection

  • list of VirtualMachineInterface objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Reference to VMI on which BGPaaS BGP peering will happen.

  • list of ServiceHealthCheck objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to health check object attached to BGPaaS object, used to enable BFD health check over

    active BGPaaS VMI.

  • list of BgpRouter objects

    Created By: System

    Operations Allowed: CRUD

    Description:

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

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_bgp_router(ref_obj)

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

Parameters:ref_obj – BgpRouter object
add_control_node_zone(ref_obj, ref_data=None)

Add control-node-zone to bgp-as-a-service.

Parameters:
  • ref_obj – ControlNodeZone object
  • ref_data – BGPaaSControlNodeZoneAttributes object
add_service_health_check(ref_obj)

Add service-health-check to bgp-as-a-service.

Parameters:ref_obj – ServiceHealthCheck object
add_tag(ref_obj)

Add tag to bgp-as-a-service.

Parameters:ref_obj – Tag object
add_virtual_machine_interface(ref_obj)

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

Parameters:ref_obj – VirtualMachineInterface object
annotations

Get annotations for bgp-as-a-service.

Returns:KeyValuePairs 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_shared

Get bgpaas-shared for bgp-as-a-service.

Returns:xsd:boolean 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_control_node_zone_refs()

Return control-node-zone list for bgp-as-a-service.

Returns:list of tuple <ControlNodeZone, BGPaaSControlNodeZoneAttributes>
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_service_health_check_refs()

Return service-health-check list for bgp-as-a-service.

Returns:list of <ServiceHealthCheck>
get_tag_refs()

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

Returns:list of <Tag>
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_control_node_zone(ref_obj, ref_data=None)

Set control-node-zone for bgp-as-a-service.

Parameters:
  • ref_obj – ControlNodeZone object
  • ref_data – BGPaaSControlNodeZoneAttributes object
set_control_node_zone_list(ref_obj_list, ref_data_list=None)

Set control-node-zone list for bgp-as-a-service.

Parameters:
  • ref_obj_list – list of ControlNodeZone object
  • ref_data_list – list of BGPaaSControlNodeZoneAttributes object
set_service_health_check(ref_obj)

Set service-health-check for bgp-as-a-service.

Parameters:ref_obj – ServiceHealthCheck object
set_service_health_check_list(ref_obj_list)

Set service-health-check list for bgp-as-a-service.

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

Set tag for bgp-as-a-service.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

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

Parameters:ref_obj_list – list of Tag 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 gen.resource_common.BgpRouter(name=None, parent_obj=None, bgp_router_parameters=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:
User
Child of:
RoutingInstance object
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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 ControlNodeZone objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This bgp-router belongs to the referenced control-node-zone.

  • list of SubCluster objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference of bgp-router to sub-cluster .

  • 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.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_bgp_router(ref_obj, ref_data=None)

Add bgp-router to bgp-router.

Parameters:
  • ref_obj – BgpRouter object
  • ref_data – BgpPeeringAttributes object
add_control_node_zone(ref_obj)

Add control-node-zone to bgp-router.

Parameters:ref_obj – ControlNodeZone object
add_sub_cluster(ref_obj)

Add sub-cluster to bgp-router.

Parameters:ref_obj – SubCluster object
add_tag(ref_obj)

Add tag to bgp-router.

Parameters:ref_obj – Tag object
annotations

Get annotations for bgp-router.

Returns:KeyValuePairs 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_control_node_zone_refs()

Return control-node-zone list for bgp-router.

Returns:list of <ControlNodeZone>
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_sub_cluster_refs()

Return sub-cluster list for bgp-router.

Returns:list of <SubCluster>
get_tag_refs()

Return tag list for bgp-router.

Returns:list of <Tag>
get_type()

Return object type (bgp-router).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this 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=None)

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=None)

Set bgp-router list for bgp-router.

Parameters:
  • ref_obj_list – list of BgpRouter object
  • ref_data_list – list of BgpPeeringAttributes object
set_control_node_zone(ref_obj)

Set control-node-zone for bgp-router.

Parameters:ref_obj – ControlNodeZone object
set_control_node_zone_list(ref_obj_list)

Set control-node-zone list for bgp-router.

Parameters:ref_obj_list – list of ControlNodeZone object
set_sub_cluster(ref_obj)

Set sub-cluster for bgp-router.

Parameters:ref_obj – SubCluster object
set_sub_cluster_list(ref_obj_list)

Set sub-cluster list for bgp-router.

Parameters:ref_obj_list – list of SubCluster object
set_tag(ref_obj)

Set tag for bgp-router.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for bgp-router.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.Bgpvpn(name=None, parent_obj=None, route_target_list=None, import_route_target_list=None, export_route_target_list=None, bgpvpn_type='l3', id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

BGP VPN resource contains a set of parameters for a BGP-based VPN

Created By:
User
Child of:
Project object
Properties:
  • 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.

  • bgpvpn_type

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

    Created By: User (required)

    Operations Allowed: CR

    Description:

    BGP VPN type selection between IP VPN (l3) and Ethernet VPN (l2) (default: l3).

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to bgpvpn.

Parameters:ref_obj – Tag object
annotations

Get annotations for bgpvpn.

Returns:KeyValuePairs object
bgpvpn_type

Get bgpvpn-type for bgpvpn.

Returns:VpnType object
display_name

Get display-name for bgpvpn.

Returns:xsd:string object
dump()

Display bgpvpn object in compact form.

export_route_target_list

Get export-route-target-list for bgpvpn.

Returns:RouteTargetList object
get_fq_name()

Return FQN of bgpvpn in list form.

get_fq_name_str()

Return FQN of bgpvpn as colon delimited string.

get_logical_router_back_refs()

Return list of all logical-routers using this bgpvpn

get_parent_fq_name()

Return FQN of bgpvpn’s parent in list form.

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for bgpvpn.

Returns:list of <Tag>
get_type()

Return object type (bgpvpn).

get_virtual_network_back_refs()

Return list of all virtual-networks using this bgpvpn

id_perms

Get id-perms for bgpvpn.

Returns:IdPermsType object
import_route_target_list

Get import-route-target-list for bgpvpn.

Returns:RouteTargetList object
perms2

Get perms2 for bgpvpn.

Returns:PermType2 object
route_target_list

Get route-target-list for bgpvpn.

Returns:RouteTargetList object
set_tag(ref_obj)

Set tag for bgpvpn.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for bgpvpn.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.BridgeDomain(name=None, parent_obj=None, mac_learning_enabled=False, mac_limit_control=None, mac_move_control=None, mac_aging_time=300, isid=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

bridge-domains configured in a virtual network

Created By:
User
Child of:
VirtualNetwork object
Properties:
  • mac_learning_enabled

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Enable MAC learning on the network

  • mac_limit_control

    Type: MACLimitControlType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    MAC limit control on the network

  • mac_move_control

    Type: MACMoveLimitControlType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    MAC move control on the network

  • mac_aging_time

    Type: int, within [0, 86400]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    MAC aging time on the network

  • isid

    Type: int, within [1, 16777215]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    i-sid value

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to bridge-domain.

Parameters:ref_obj – Tag object
annotations

Get annotations for bridge-domain.

Returns:KeyValuePairs object
display_name

Get display-name for bridge-domain.

Returns:xsd:string object
dump()

Display bridge-domain object in compact form.

get_fq_name()

Return FQN of bridge-domain in list form.

get_fq_name_str()

Return FQN of bridge-domain as colon delimited string.

get_parent_fq_name()

Return FQN of bridge-domain’s parent in list form.

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for bridge-domain.

Returns:list of <Tag>
get_type()

Return object type (bridge-domain).

get_virtual_machine_interface_back_refs()

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

id_perms

Get id-perms for bridge-domain.

Returns:IdPermsType object
isid

Get isid for bridge-domain.

Returns:IsidType object
mac_aging_time

Get mac-aging-time for bridge-domain.

Returns:MACAgingTime object
mac_learning_enabled

Get mac-learning-enabled for bridge-domain.

Returns:xsd:boolean object
mac_limit_control

Get mac-limit-control for bridge-domain.

Returns:MACLimitControlType object
mac_move_control

Get mac-move-control for bridge-domain.

Returns:MACMoveLimitControlType object
perms2

Get perms2 for bridge-domain.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for bridge-domain.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for bridge-domain.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.Card(name=None, interface_map=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

This resource contains the information about the interface card in a hardware platform.

Created By:

Properties:
  • interface_map

    Type: InterfaceMapType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Interface map of all the physical ports on a physical interface card.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to card.

Parameters:ref_obj – Tag object
annotations

Get annotations for card.

Returns:KeyValuePairs object
display_name

Get display-name for card.

Returns:xsd:string object
dump()

Display card object in compact form.

get_fq_name()

Return FQN of card in list form.

get_fq_name_str()

Return FQN of card as colon delimited string.

get_hardware_back_refs()

Return list of all hardwares using this card

get_tag_refs()

Return tag list for card.

Returns:list of <Tag>
get_type()

Return object type (card).

id_perms

Get id-perms for card.

Returns:IdPermsType object
interface_map

Get interface-map for card.

Returns:InterfaceMapType object
perms2

Get perms2 for card.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for card.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for card.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.CliConfig(name=None, parent_obj=None, accepted_cli_config=None, commit_diff_list=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

CLI commits done on a physical router.

Created By:
User
Child of:
PhysicalRouter object
Properties:
  • accepted_cli_config

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Aggregated cli accepted configs. This config will be pushed when the device undergoes RMA along with

    Contrail configuration

  • commit_diff_list

    Type: CliDiffListType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    CLI diff object containing details about the commit such as username, time and the configuration

    diff

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

accepted_cli_config

Get accepted-cli-config for cli-config.

Returns:xsd:string object
add_tag(ref_obj)

Add tag to cli-config.

Parameters:ref_obj – Tag object
annotations

Get annotations for cli-config.

Returns:KeyValuePairs object
commit_diff_list

Get commit-diff-list for cli-config.

Returns:CliDiffListType object
display_name

Get display-name for cli-config.

Returns:xsd:string object
dump()

Display cli-config object in compact form.

get_fq_name()

Return FQN of cli-config in list form.

get_fq_name_str()

Return FQN of cli-config as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for cli-config.

Returns:list of <Tag>
get_type()

Return object type (cli-config).

id_perms

Get id-perms for cli-config.

Returns:IdPermsType object
perms2

Get perms2 for cli-config.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for cli-config.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for cli-config.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.ConfigDatabaseNode(name=None, parent_obj=None, config_database_node_ip_address=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Config Database node is object representing a logical node in system which hosts Cassandra DB and Zookeeper for Config.

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • config_database_node_ip_address

    Type: str, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Ip address of the Config DB node, set while provisioning.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to config-database-node.

Parameters:ref_obj – Tag object
annotations

Get annotations for config-database-node.

Returns:KeyValuePairs object
config_database_node_ip_address

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

Returns:IpAddressType object
display_name

Get display-name for config-database-node.

Returns:xsd:string object
dump()

Display config-database-node object in compact form.

get_fq_name()

Return FQN of config-database-node in list form.

get_fq_name_str()

Return FQN of config-database-node as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for config-database-node.

Returns:list of <Tag>
get_type()

Return object type (config-database-node).

id_perms

Get id-perms for config-database-node.

Returns:IdPermsType object
perms2

Get perms2 for config-database-node.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for config-database-node.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for config-database-node.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.ConfigNode(name=None, parent_obj=None, config_node_ip_address=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • config_node_ip_address

    Type: str, 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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to config-node.

Parameters:ref_obj – Tag object
annotations

Get annotations for config-node.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for config-node.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for config-node.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for config-node.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.ConfigProperties(name=None, parent_obj=None, properties=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

List of config properties.

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • properties

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of Config properties

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to config-properties.

Parameters:ref_obj – Tag object
annotations

Get annotations for config-properties.

Returns:KeyValuePairs object
display_name

Get display-name for config-properties.

Returns:xsd:string object
dump()

Display config-properties object in compact form.

get_fq_name()

Return FQN of config-properties in list form.

get_fq_name_str()

Return FQN of config-properties as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for config-properties.

Returns:list of <Tag>
get_type()

Return object type (config-properties).

id_perms

Get id-perms for config-properties.

Returns:IdPermsType object
perms2

Get perms2 for config-properties.

Returns:PermType2 object
properties

Get properties for config-properties.

Returns:KeyValuePairs object
set_tag(ref_obj)

Set tag for config-properties.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for config-properties.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.ConfigRoot(name=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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.

  • list of PolicyManagement objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Global level policy-management object re-grouping global policy resources.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Attribute attached to objects - has a type and value

References to:
  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Attribute attached to objects - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to config-root.

Parameters:ref_obj – Tag object
annotations

Get annotations for config-root.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for config-root.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for config-root.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for config-root.

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

Bases: future.types.newobject.newobject

List of references to all control-node-zones in systems.

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to control-node-zone.

Parameters:ref_obj – Tag object
annotations

Get annotations for control-node-zone.

Returns:KeyValuePairs object
display_name

Get display-name for control-node-zone.

Returns:xsd:string object
dump()

Display control-node-zone object in compact form.

get_bgp_as_a_service_back_refs()

Return list of all bgp-as-a-services using this control-node-zone

get_bgp_router_back_refs()

Return list of all bgp-routers using this control-node-zone

get_fq_name()

Return FQN of control-node-zone in list form.

get_fq_name_str()

Return FQN of control-node-zone as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for control-node-zone.

Returns:list of <Tag>
get_type()

Return object type (control-node-zone).

id_perms

Get id-perms for control-node-zone.

Returns:IdPermsType object
perms2

Get perms2 for control-node-zone.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for control-node-zone.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for control-node-zone.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.CustomerAttachment(name=None, attachment_address=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

Properties:
  • attachment_address

    Type: AttachmentAddressType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_floating_ip(ref_obj)

Add floating-ip to customer-attachment.

Parameters:ref_obj – FloatingIp object
add_tag(ref_obj)

Add tag to customer-attachment.

Parameters:ref_obj – Tag object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to customer-attachment.

Parameters:ref_obj – VirtualMachineInterface object
annotations

Get annotations for customer-attachment.

Returns:KeyValuePairs 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_tag_refs()

Return tag list for customer-attachment.

Returns:list of <Tag>
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_tag(ref_obj)

Set tag for customer-attachment.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for customer-attachment.

Parameters:ref_obj_list – list of Tag 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 gen.resource_common.DataCenterInterconnect(name=None, parent_obj=None, data_center_interconnect_bgp_hold_time=None, data_center_interconnect_mode=None, data_center_interconnect_bgp_address_families=None, data_center_interconnect_configured_route_target_list=None, data_center_interconnect_type=None, destination_physical_router_list=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

List of DCI Objects in the system. Each DCI represents an interconnect of Multiple Fabrics or interconnect of LRs in same fabric.

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • data_center_interconnect_bgp_hold_time

    Type: int, within [0, 65535]

    Created By: User (optional)

    Operations Allowed: CRUD

    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.

  • data_center_interconnect_mode

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

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Data Center InterConnect modes can be l2 or l3.

    l2 - DCI mode l2 stretch.

    l3 - DCI mode l3 stretch.

  • data_center_interconnect_bgp_address_families

    Type: AddressFamilies

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    BGP address families supported by BGP router.

  • data_center_interconnect_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 DCI

    will have this as their route target list.

  • data_center_interconnect_type

    Type: str, one-of [u’inter_fabric’, u’intra_fabric’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Defines type of DCI, inter-fabric is across two fabric. intra-fabric is single fabric.

  • destination_physical_router_list

    Type: LogicalRouterPRListType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    holds List of physical router uuid of destination LR(s) in intra-fabric type DCI object

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 LogicalRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of LRs one from each fabric participating in the DCI, each LR belongs to different fabric

  • list of VirtualNetwork objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    reference to auto created internal virtual network, used for connecting different data centers for

    DCI type inter-fabric and intra-fabric. For intra-fabric type DCI, if user does not provided any

    DCI-routing-policy then this refs holds list of tenant virtual networks refs provided and selected

    by users. this refs will be list of tenant VN which existed in source LR for intra-fabric type DCI.

    routes will be leak only for this list of VNs subnets in intra-fabric DCI.

  • list of RoutingPolicy objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Used only if DCI-type is intra-fabric. it stores the List of routing policies for this DCI to be

    used as import policies between logical routers. if any single or more routing policy defined in

    this property then DCI-virtual-network-refs property value will be ignored for route leaks route-

    filter.

  • list of Fabric objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to fabric, this link enables to identify which fabric this DCI belongs to. This refs used

    for l2 mode inter-fabric dci

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_fabric(ref_obj)

Add fabric to data-center-interconnect.

Parameters:ref_obj – Fabric object
add_logical_router(ref_obj)

Add logical-router to data-center-interconnect.

Parameters:ref_obj – LogicalRouter object
add_routing_policy(ref_obj)

Add routing-policy to data-center-interconnect.

Parameters:ref_obj – RoutingPolicy object
add_tag(ref_obj)

Add tag to data-center-interconnect.

Parameters:ref_obj – Tag object
add_virtual_network(ref_obj)

Add virtual-network to data-center-interconnect.

Parameters:ref_obj – VirtualNetwork object
annotations

Get annotations for data-center-interconnect.

Returns:KeyValuePairs object
data_center_interconnect_bgp_address_families

Get data-center-interconnect-bgp-address-families for data-center-interconnect.

Returns:AddressFamilies object
data_center_interconnect_bgp_hold_time

Get data-center-interconnect-bgp-hold-time for data-center-interconnect.

Returns:BgpHoldTime object
data_center_interconnect_configured_route_target_list

Get data-center-interconnect-configured-route-target-list for data-center-interconnect.

Returns:RouteTargetList object
data_center_interconnect_mode

Get data-center-interconnect-mode for data-center-interconnect.

Returns:DataCenterInterconnectModes object
data_center_interconnect_type

Get data-center-interconnect-type for data-center-interconnect.

Returns:DataCenterInterConnectType object
destination_physical_router_list

Get destination-physical-router-list for data-center-interconnect.

Returns:LogicalRouterPRListType object
display_name

Get display-name for data-center-interconnect.

Returns:xsd:string object
dump()

Display data-center-interconnect object in compact form.

get_fabric_refs()

Return fabric list for data-center-interconnect.

Returns:list of <Fabric>
get_fq_name()

Return FQN of data-center-interconnect in list form.

get_fq_name_str()

Return FQN of data-center-interconnect as colon delimited string.

get_logical_router_refs()

Return logical-router list for data-center-interconnect.

Returns:list of <LogicalRouter>
get_parent_fq_name()

Return FQN of data-center-interconnect’s parent in list form.

get_parent_fq_name_str()

Return FQN of data-center-interconnect’s parent as colon delimted string.

get_routing_policy_refs()

Return routing-policy list for data-center-interconnect.

Returns:list of <RoutingPolicy>
get_tag_refs()

Return tag list for data-center-interconnect.

Returns:list of <Tag>
get_type()

Return object type (data-center-interconnect).

get_virtual_network_refs()

Return virtual-network list for data-center-interconnect.

Returns:list of <VirtualNetwork>
id_perms

Get id-perms for data-center-interconnect.

Returns:IdPermsType object
perms2

Get perms2 for data-center-interconnect.

Returns:PermType2 object
set_fabric(ref_obj)

Set fabric for data-center-interconnect.

Parameters:ref_obj – Fabric object
set_fabric_list(ref_obj_list)

Set fabric list for data-center-interconnect.

Parameters:ref_obj_list – list of Fabric object
set_logical_router(ref_obj)

Set logical-router for data-center-interconnect.

Parameters:ref_obj – LogicalRouter object
set_logical_router_list(ref_obj_list)

Set logical-router list for data-center-interconnect.

Parameters:ref_obj_list – list of LogicalRouter object
set_routing_policy(ref_obj)

Set routing-policy for data-center-interconnect.

Parameters:ref_obj – RoutingPolicy object
set_routing_policy_list(ref_obj_list)

Set routing-policy list for data-center-interconnect.

Parameters:ref_obj_list – list of RoutingPolicy object
set_tag(ref_obj)

Set tag for data-center-interconnect.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for data-center-interconnect.

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

Set virtual-network for data-center-interconnect.

Parameters:ref_obj – VirtualNetwork object
set_virtual_network_list(ref_obj_list)

Set virtual-network list for data-center-interconnect.

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

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • database_node_ip_address

    Type: str, 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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to database-node.

Parameters:ref_obj – Tag object
annotations

Get annotations for database-node.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for database-node.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for database-node.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for database-node.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.DeviceChassis(name=None, device_chassis_type=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

This resource contains information about the device chassis. The PR can refer to this object for chassis details. This resource name must follow the convention: ‘vendorname_chassismac’ (replacing mac ‘:’ with ‘_’), for example, ‘juniper_00_11_22_33_44_55’

Created By:

Properties:
  • device_chassis_type

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    type of the chassis address if known.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to device-chassis.

Parameters:ref_obj – Tag object
annotations

Get annotations for device-chassis.

Returns:KeyValuePairs object
device_chassis_type

Get device-chassis-type for device-chassis.

Returns:xsd:string object
display_name

Get display-name for device-chassis.

Returns:xsd:string object
dump()

Display device-chassis object in compact form.

get_fq_name()

Return FQN of device-chassis in list form.

get_fq_name_str()

Return FQN of device-chassis as colon delimited string.

get_physical_router_back_refs()

Return list of all physical-routers using this device-chassis

get_tag_refs()

Return tag list for device-chassis.

Returns:list of <Tag>
get_type()

Return object type (device-chassis).

id_perms

Get id-perms for device-chassis.

Returns:IdPermsType object
perms2

Get perms2 for device-chassis.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for device-chassis.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for device-chassis.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.DeviceFunctionalGroup(name=None, parent_obj=None, device_functional_group_description=None, device_functional_group_os_version=None, device_functional_group_routing_bridging_roles=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Device functional group is used to group together any selected list of devices for the purpose of assigning identical attributes. For example, os-version, physical-roles, rb-roles

Created By:
User
Child of:
Project object
Properties:
  • device_functional_group_description

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Description of the functional group stating the functionality the devices would get if assigned to

    this group

  • device_functional_group_os_version

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    OS version for devices in this group. If set, it is the first choice for device image upgrade during

    ztp. If not set, fabric-os-version is used

  • device_functional_group_routing_bridging_roles

    Type: RoutingBridgingRolesType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Routing-bridging role (e.g. CRB, ERB, etc.), used by the device manager to provision physical

    router, for e.g device manager may choose to configure physical router based on its role.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 PhysicalRole objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Physical role assigned to all physical routers which are members of this device functional group

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_physical_role(ref_obj)

Add physical-role to device-functional-group.

Parameters:ref_obj – PhysicalRole object
add_tag(ref_obj)

Add tag to device-functional-group.

Parameters:ref_obj – Tag object
annotations

Get annotations for device-functional-group.

Returns:KeyValuePairs object
device_functional_group_description

Get device-functional-group-description for device-functional-group.

Returns:xsd:string object
device_functional_group_os_version

Get device-functional-group-os-version for device-functional-group.

Returns:xsd:string object
device_functional_group_routing_bridging_roles

Get device-functional-group-routing-bridging-roles for device-functional-group.

Returns:RoutingBridgingRolesType object
display_name

Get display-name for device-functional-group.

Returns:xsd:string object
dump()

Display device-functional-group object in compact form.

get_fq_name()

Return FQN of device-functional-group in list form.

get_fq_name_str()

Return FQN of device-functional-group as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_physical_role_refs()

Return physical-role list for device-functional-group.

Returns:list of <PhysicalRole>
get_physical_router_back_refs()

Return list of all physical-routers using this device-functional-group

get_tag_refs()

Return tag list for device-functional-group.

Returns:list of <Tag>
get_type()

Return object type (device-functional-group).

id_perms

Get id-perms for device-functional-group.

Returns:IdPermsType object
perms2

Get perms2 for device-functional-group.

Returns:PermType2 object
set_physical_role(ref_obj)

Set physical-role for device-functional-group.

Parameters:ref_obj – PhysicalRole object
set_physical_role_list(ref_obj_list)

Set physical-role list for device-functional-group.

Parameters:ref_obj_list – list of PhysicalRole object
set_tag(ref_obj)

Set tag for device-functional-group.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for device-functional-group.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.DeviceImage(name=None, parent_obj=None, device_image_file_name=None, device_image_vendor_name=None, device_image_device_family=None, device_image_supported_platforms=None, device_image_os_version=None, device_image_file_uri=None, device_image_size=None, device_image_md5=None, device_image_sha1=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

list of device image info for the images that get uploaded to the system.

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • device_image_file_name

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Name of the device image. As of now, for Juniper devices, it will be used by device manager during

    image upgrade to send additional flag for vmhost based REs.

  • device_image_vendor_name

    Type: str

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Vendor name for device image. It is used by device manager during device image upgrade to match the

    PRouters vendor name

  • device_image_device_family

    Type: str

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Device family name for device image. It is used by device manager during device image upgrade to

    match the family name of the PRouter

  • device_image_supported_platforms

    Type: DevicePlatformListType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of device platforms that this image can be installed on. It is used by device manager during

    device image upgrade validate the PRouters product_name property. If this property is not specified,

    then this image can be installed on all platforms of the device family

  • device_image_os_version

    Type: str

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    OS version string on the device where this image is installed. This version string should match the

    PRouters operational state PRouterUVE.os_version attribute if the image is successfully installed on

    the PRouter

  • device_image_file_uri

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    file uri for the device image uploaded to the image server.

  • device_image_size

    Type: int

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    file size of the device image that was uploaded to the image server.

  • device_image_md5

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    md5 checksum of the image file that was uploaded to the image server.

  • device_image_sha1

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    sha1 checksum of the image file that was uploaded to the image server.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Hardware objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    linking the hardware that is associated to image

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_hardware(ref_obj)

Add hardware to device-image.

Parameters:ref_obj – Hardware object
add_tag(ref_obj)

Add tag to device-image.

Parameters:ref_obj – Tag object
annotations

Get annotations for device-image.

Returns:KeyValuePairs object
device_image_device_family

Get device-image-device-family for device-image.

Returns:xsd:string object
device_image_file_name

Get device-image-file-name for device-image.

Returns:xsd:string object
device_image_file_uri

Get device-image-file-uri for device-image.

Returns:xsd:string object
device_image_md5

Get device-image-md5 for device-image.

Returns:xsd:string object
device_image_os_version

Get device-image-os-version for device-image.

Returns:xsd:string object
device_image_sha1

Get device-image-sha1 for device-image.

Returns:xsd:string object
device_image_size

Get device-image-size for device-image.

Returns:xsd:integer object
device_image_supported_platforms

Get device-image-supported-platforms for device-image.

Returns:DevicePlatformListType object
device_image_vendor_name

Get device-image-vendor-name for device-image.

Returns:xsd:string object
display_name

Get display-name for device-image.

Returns:xsd:string object
dump()

Display device-image object in compact form.

get_fq_name()

Return FQN of device-image in list form.

get_fq_name_str()

Return FQN of device-image as colon delimited string.

get_hardware_refs()

Return hardware list for device-image.

Returns:list of <Hardware>
get_parent_fq_name()

Return FQN of device-image’s parent in list form.

get_parent_fq_name_str()

Return FQN of device-image’s parent as colon delimted string.

get_physical_router_back_refs()

Return list of all physical-routers using this device-image

get_tag_refs()

Return tag list for device-image.

Returns:list of <Tag>
get_type()

Return object type (device-image).

id_perms

Get id-perms for device-image.

Returns:IdPermsType object
perms2

Get perms2 for device-image.

Returns:PermType2 object
set_hardware(ref_obj)

Set hardware for device-image.

Parameters:ref_obj – Hardware object
set_hardware_list(ref_obj_list)

Set hardware list for device-image.

Parameters:ref_obj_list – list of Hardware object
set_tag(ref_obj)

Set tag for device-image.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for device-image.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.DevicemgrNode(name=None, parent_obj=None, devicemgr_node_ip_address=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

devicemgr node is object representing a logical node in system for configuring physical devices.

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • devicemgr_node_ip_address

    Type: str, one-of xsd:string

    Created By: User (admin-only)

    Operations Allowed: CRUD

    Description:

    Ip address of the devicemgr node, set while provisioning.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to devicemgr-node.

Parameters:ref_obj – Tag object
annotations

Get annotations for devicemgr-node.

Returns:KeyValuePairs object
devicemgr_node_ip_address

Get devicemgr-node-ip-address for devicemgr-node.

Returns:IpAddressType object
display_name

Get display-name for devicemgr-node.

Returns:xsd:string object
dump()

Display devicemgr-node object in compact form.

get_fq_name()

Return FQN of devicemgr-node in list form.

get_fq_name_str()

Return FQN of devicemgr-node as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for devicemgr-node.

Returns:list of <Tag>
get_type()

Return object type (devicemgr-node).

id_perms

Get id-perms for devicemgr-node.

Returns:IdPermsType object
perms2

Get perms2 for devicemgr-node.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for devicemgr-node.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for devicemgr-node.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.DiscoveryServiceAssignment(name=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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:
  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to discovery-service-assignment.

Parameters:ref_obj – Tag object
annotations

Get annotations for discovery-service-assignment.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for discovery-service-assignment.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for discovery-service-assignment.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for discovery-service-assignment.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.Domain(name=None, parent_obj=None, domain_limits=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Domain is authentication namespace, a collection of projects.

Created By:
User
Child of:
ConfigRoot object
Properties:
  • domain_limits

    Type: DomainLimitsType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Domain level quota, not currently implemented

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 template defines how a service may be deployed in the network. Service instance is

    instantiated from config in service template.

  • 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 service 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

    domain level.

References to:
  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to domain.

Parameters:ref_obj – Tag object
annotations

Get annotations for domain.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for domain.

Returns:list of <Tag>
get_type()

Return object type (domain).

id_perms

Get id-perms for domain.

Returns:IdPermsType object
perms2

Get perms2 for domain.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for domain.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for domain.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.DsaRule(name=None, parent_obj=None, dsa_rule_entry=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
DiscoveryServiceAssignment object
Properties:
  • dsa_rule_entry

    Type: DiscoveryServiceAssignmentType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    rule entry defining publisher set and subscriber set.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to dsa-rule.

Parameters:ref_obj – Tag object
annotations

Get annotations for dsa-rule.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for dsa-rule.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for dsa-rule.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for dsa-rule.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.E2ServiceProvider(name=None, e2_service_provider_promiscuous=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

Properties:
  • e2_service_provider_promiscuous

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This service provider is connected to all other service providers.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 PeeringPolicy objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Links the service provider to a peering policy.

  • list of PhysicalRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Links the service provider to peer routers.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_peering_policy(ref_obj)

Add peering-policy to e2-service-provider.

Parameters:ref_obj – PeeringPolicy object
add_physical_router(ref_obj)

Add physical-router to e2-service-provider.

Parameters:ref_obj – PhysicalRouter object
add_tag(ref_obj)

Add tag to e2-service-provider.

Parameters:ref_obj – Tag object
annotations

Get annotations for e2-service-provider.

Returns:KeyValuePairs object
display_name

Get display-name for e2-service-provider.

Returns:xsd:string object
dump()

Display e2-service-provider object in compact form.

e2_service_provider_promiscuous

Get e2-service-provider-promiscuous for e2-service-provider.

Returns:xsd:boolean object
get_fq_name()

Return FQN of e2-service-provider in list form.

get_fq_name_str()

Return FQN of e2-service-provider as colon delimited string.

get_peering_policy_refs()

Return peering-policy list for e2-service-provider.

Returns:list of <PeeringPolicy>
get_physical_router_refs()

Return physical-router list for e2-service-provider.

Returns:list of <PhysicalRouter>
get_tag_refs()

Return tag list for e2-service-provider.

Returns:list of <Tag>
get_type()

Return object type (e2-service-provider).

id_perms

Get id-perms for e2-service-provider.

Returns:IdPermsType object
perms2

Get perms2 for e2-service-provider.

Returns:PermType2 object
set_peering_policy(ref_obj)

Set peering-policy for e2-service-provider.

Parameters:ref_obj – PeeringPolicy object
set_peering_policy_list(ref_obj_list)

Set peering-policy list for e2-service-provider.

Parameters:ref_obj_list – list of PeeringPolicy object
set_physical_router(ref_obj)

Set physical-router for e2-service-provider.

Parameters:ref_obj – PhysicalRouter object
set_physical_router_list(ref_obj_list)

Set physical-router list for e2-service-provider.

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

Set tag for e2-service-provider.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for e2-service-provider.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.Fabric(name=None, parent_obj=None, fabric_ztp=None, fabric_os_version=None, fabric_credentials=None, fabric_enterprise_style=True, disable_vlan_vn_uniqueness_check=False, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

List of fabrics in the system. Each fabric is an administrative domain for all the network devices in one or multiple CLOS.

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • fabric_ztp

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This attribute to indicate if the fabric is zero-touch provisioned or not. If this attribute is set

    to “True”, user should not be allowed to remove any existing namespaces from the fabric as they may

    be used to provision the devices.

  • fabric_os_version

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    OS version of the entire fabric. It is updated when image upgrade is chosen during ztp.

  • fabric_credentials

    Type: DeviceCredentialList

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of device credentials to manage the network devices in the fabric.

  • fabric_enterprise_style

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This attribute indicates whether to use enterprise-style or sp-style configuration in the fabric.

    True indicated enterprise-style.

  • disable_vlan_vn_uniqueness_check

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This attribute indicates whether complex validations for VLAN-VN uniqueness check should be done for

    enterprise style VPGs in the fabric. Default behaviour is to enable all the validations.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 FabricNamespace objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of fabric namespaces that define a set of resources that can be used to configure the network

    devices in the fabric.

  • list of VirtualPortGroup objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of virtual port groups in this fabric.

References to:
  • list of IntentMap objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Fabric that belongs to this intent map

  • list of (VirtualNetwork object, FabricNetworkTag attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Similar to using virtual-machine to model the bare metal server, we are using virtual-network to

    model various underlay networks such as the management network and IP fabric network. This would

    allow us the re-use the same IPAM data model and code base to manage the IP auto-assignments for the

    underlay physical networks.

  • list of (NodeProfile object, SerialNumListType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    node profiles assignd to the fabric. The serial number list on the link is used to auto assign node-

    profile during ZTP so that port channelization could be bootstrapped based on the hardware spec in

    the node profile.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_intent_map(ref_obj)

Add intent-map to fabric.

Parameters:ref_obj – IntentMap object
add_node_profile(ref_obj, ref_data=None)

Add node-profile to fabric.

Parameters:
  • ref_obj – NodeProfile object
  • ref_data – SerialNumListType object
add_tag(ref_obj)

Add tag to fabric.

Parameters:ref_obj – Tag object
add_virtual_network(ref_obj, ref_data=None)

Add virtual-network to fabric.

Parameters:
  • ref_obj – VirtualNetwork object
  • ref_data – FabricNetworkTag object
annotations

Get annotations for fabric.

Returns:KeyValuePairs object
disable_vlan_vn_uniqueness_check

Get disable-vlan-vn-uniqueness-check for fabric.

Returns:xsd:boolean object
display_name

Get display-name for fabric.

Returns:xsd:string object
dump()

Display fabric object in compact form.

fabric_credentials

Get fabric-credentials for fabric.

Returns:DeviceCredentialList object
fabric_enterprise_style

Get fabric-enterprise-style for fabric.

Returns:xsd:boolean object
fabric_os_version

Get fabric-os-version for fabric.

Returns:xsd:string object
fabric_ztp

Get fabric-ztp for fabric.

Returns:xsd:boolean object
get_data_center_interconnect_back_refs()

Return list of all data-center-interconnects using this fabric

get_fq_name()

Return FQN of fabric in list form.

get_fq_name_str()

Return FQN of fabric as colon delimited string.

get_intent_map_refs()

Return intent-map list for fabric.

Returns:list of <IntentMap>
get_logical_router_back_refs()

Return list of all logical-routers using this fabric

get_node_profile_refs()

Return node-profile list for fabric.

Returns:list of tuple <NodeProfile, SerialNumListType>
get_parent_fq_name()

Return FQN of fabric’s parent in list form.

get_parent_fq_name_str()

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

get_physical_router_back_refs()

Return list of all physical-routers using this fabric

get_tag_refs()

Return tag list for fabric.

Returns:list of <Tag>
get_type()

Return object type (fabric).

get_virtual_network_refs()

Return virtual-network list for fabric.

Returns:list of tuple <VirtualNetwork, FabricNetworkTag>
id_perms

Get id-perms for fabric.

Returns:IdPermsType object
perms2

Get perms2 for fabric.

Returns:PermType2 object
set_intent_map(ref_obj)

Set intent-map for fabric.

Parameters:ref_obj – IntentMap object
set_intent_map_list(ref_obj_list)

Set intent-map list for fabric.

Parameters:ref_obj_list – list of IntentMap object
set_node_profile(ref_obj, ref_data=None)

Set node-profile for fabric.

Parameters:
  • ref_obj – NodeProfile object
  • ref_data – SerialNumListType object
set_node_profile_list(ref_obj_list, ref_data_list=None)

Set node-profile list for fabric.

Parameters:
  • ref_obj_list – list of NodeProfile object
  • ref_data_list – list of SerialNumListType object
set_tag(ref_obj)

Set tag for fabric.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for fabric.

Parameters:ref_obj_list – list of Tag object
set_virtual_network(ref_obj, ref_data=None)

Set virtual-network for fabric.

Parameters:
  • ref_obj – VirtualNetwork object
  • ref_data – FabricNetworkTag object
set_virtual_network_list(ref_obj_list, ref_data_list=None)

Set virtual-network list for fabric.

Parameters:
  • ref_obj_list – list of VirtualNetwork object
  • ref_data_list – list of FabricNetworkTag object
class gen.resource_common.FabricNamespace(name=None, parent_obj=None, fabric_namespace_type=None, fabric_namespace_value=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

list of fabric namespaces that define a set of resources that can be used to configure the network devices in the fabric.

Created By:
User
Child of:
Fabric object
Properties:
  • fabric_namespace_type

    Type: str, one-of [u’IPV4-CIDR’, u’ASN’, u’ASN_RANGE’, u’MAC_ADDR’, u’SERIAL_NUM’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Supported namespace types

  • fabric_namespace_value

    Type: NamespaceValue

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    namespace value of type defined by the namespace-type.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to fabric-namespace.

Parameters:ref_obj – Tag object
annotations

Get annotations for fabric-namespace.

Returns:KeyValuePairs object
display_name

Get display-name for fabric-namespace.

Returns:xsd:string object
dump()

Display fabric-namespace object in compact form.

fabric_namespace_type

Get fabric-namespace-type for fabric-namespace.

Returns:NamespaceType object
fabric_namespace_value

Get fabric-namespace-value for fabric-namespace.

Returns:NamespaceValue object
get_fq_name()

Return FQN of fabric-namespace in list form.

get_fq_name_str()

Return FQN of fabric-namespace as colon delimited string.

get_parent_fq_name()

Return FQN of fabric-namespace’s parent in list form.

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for fabric-namespace.

Returns:list of <Tag>
get_type()

Return object type (fabric-namespace).

id_perms

Get id-perms for fabric-namespace.

Returns:IdPermsType object
perms2

Get perms2 for fabric-namespace.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for fabric-namespace.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for fabric-namespace.

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

Bases: future.types.newobject.newobject

A granual networking feature supported by Fabric Manager

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Feature objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of features this feature is dependent on.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_feature(ref_obj)

Add feature to feature.

Parameters:ref_obj – Feature object
add_tag(ref_obj)

Add tag to feature.

Parameters:ref_obj – Tag object
annotations

Get annotations for feature.

Returns:KeyValuePairs object
display_name

Get display-name for feature.

Returns:xsd:string object
dump()

Display feature object in compact form.

get_feature_back_refs()

Return list of all features using this feature

get_feature_refs()

Return feature list for feature.

Returns:list of <Feature>
get_fq_name()

Return FQN of feature in list form.

get_fq_name_str()

Return FQN of feature as colon delimited string.

get_parent_fq_name()

Return FQN of feature’s parent in list form.

get_parent_fq_name_str()

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

get_role_definition_back_refs()

Return list of all role-definitions using this feature

get_tag_refs()

Return tag list for feature.

Returns:list of <Tag>
get_type()

Return object type (feature).

id_perms

Get id-perms for feature.

Returns:IdPermsType object
perms2

Get perms2 for feature.

Returns:PermType2 object
set_feature(ref_obj)

Set feature for feature.

Parameters:ref_obj – Feature object
set_feature_list(ref_obj_list)

Set feature list for feature.

Parameters:ref_obj_list – list of Feature object
set_tag(ref_obj)

Set tag for feature.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for feature.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.FeatureConfig(name=None, parent_obj=None, feature_config_additional_params=None, feature_config_vendor_config=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Vendor specific and/or feature specific configuration parameters editable by the user

Created By:
User
Child of:
RoleDefinition object
Properties:
  • feature_config_additional_params

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Additional configuration parameters for the feature.

  • feature_config_vendor_config

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Vendor specific configuration/parameters for the feature.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to feature-config.

Parameters:ref_obj – Tag object
annotations

Get annotations for feature-config.

Returns:KeyValuePairs object
display_name

Get display-name for feature-config.

Returns:xsd:string object
dump()

Display feature-config object in compact form.

feature_config_additional_params

Get feature-config-additional-params for feature-config.

Returns:KeyValuePairs object
feature_config_vendor_config

Get feature-config-vendor-config for feature-config.

Returns:KeyValuePairs object
get_fq_name()

Return FQN of feature-config in list form.

get_fq_name_str()

Return FQN of feature-config as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for feature-config.

Returns:list of <Tag>
get_type()

Return object type (feature-config).

id_perms

Get id-perms for feature-config.

Returns:IdPermsType object
perms2

Get perms2 for feature-config.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for feature-config.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for feature-config.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.FeatureFlag(name=None, parent_obj=None, feature_description=None, feature_id=None, feature_flag_version=None, feature_release=None, enable_feature=False, feature_state=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Feature Flag to swtich on/off the allowed feature

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • feature_description

    Type: str

    Created By: System

    Operations Allowed: R

    Description:

    short explanation about the feature.

  • feature_id

    Type: str, one-of [u’default’, u’__test_feature_1__’, u’__test_feature_2__’]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    identifier for this feature

  • feature_flag_version

    Type: str

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    contrail release in which this feature flag is created.

  • feature_release

    Type: str

    Created By: System

    Operations Allowed: R

    Description:

    version of release in which the feature is introduced.

  • enable_feature

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    knob to enable or disable an allowed feature.

  • feature_state

    Type: str, one-of [u’experimental’, u’alpha’, u’beta’, u’in-progress’, u’pre-retired’]

    Created By: System

    Operations Allowed: R

    Description:

    state of the feature

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to feature-flag.

Parameters:ref_obj – Tag object
annotations

Get annotations for feature-flag.

Returns:KeyValuePairs object
display_name

Get display-name for feature-flag.

Returns:xsd:string object
dump()

Display feature-flag object in compact form.

enable_feature

Get enable-feature for feature-flag.

Returns:xsd:boolean object
feature_description

Get feature-description for feature-flag.

Returns:xsd:string object
feature_flag_version

Get feature-flag-version for feature-flag.

Returns:xsd:string object
feature_id

Get feature-id for feature-flag.

Returns:FeatureIdType object
feature_release

Get feature-release for feature-flag.

Returns:xsd:string object
feature_state

Get feature-state for feature-flag.

Returns:FeatureStateType object
get_fq_name()

Return FQN of feature-flag in list form.

get_fq_name_str()

Return FQN of feature-flag as colon delimited string.

get_parent_fq_name()

Return FQN of feature-flag’s parent in list form.

get_parent_fq_name_str()

Return FQN of feature-flag’s parent as colon delimted string.

get_tag_refs()

Return tag list for feature-flag.

Returns:list of <Tag>
get_type()

Return object type (feature-flag).

id_perms

Get id-perms for feature-flag.

Returns:IdPermsType object
perms2

Get perms2 for feature-flag.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for feature-flag.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for feature-flag.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.FirewallPolicy(name=None, parent_obj=None, draft_mode_state=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

When parent is policy-management:
firewall-policy object consisting of one or more firewall rules
When parent is project:
Project level firewall-policy object consisting of one or more firewall rules
Created By:
User when parent is PolicyManagement User when parent is Project
Child of:
PolicyManagement object OR Project object
Properties:
  • draft_mode_state

    Type: str, one-of [u’created’, u’updated’, u’deleted’]

    Created By: User (optional)

    Operations Allowed: R

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 (FirewallRule object, FirewallSequence attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to firewall-rule attached to this firewall-policy

  • list of (SecurityLoggingObject object, SloRateType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to security-logging-object attached to this firewall-policy

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_firewall_rule(ref_obj, ref_data=None)

Add firewall-rule to firewall-policy.

Parameters:
  • ref_obj – FirewallRule object
  • ref_data – FirewallSequence object
add_security_logging_object(ref_obj, ref_data=None)

Add security-logging-object to firewall-policy.

Parameters:
  • ref_obj – SecurityLoggingObject object
  • ref_data – SloRateType object
add_tag(ref_obj)

Add tag to firewall-policy.

Parameters:ref_obj – Tag object
annotations

Get annotations for firewall-policy.

Returns:KeyValuePairs object
display_name

Get display-name for firewall-policy.

Returns:xsd:string object
draft_mode_state

Get draft-mode-state for firewall-policy.

Returns:DraftModeState object
dump()

Display firewall-policy object in compact form.

get_application_policy_set_back_refs()

Return list of all application-policy-sets using this firewall-policy

get_firewall_rule_refs()

Return firewall-rule list for firewall-policy.

Returns:list of tuple <FirewallRule, FirewallSequence>
get_fq_name()

Return FQN of firewall-policy in list form.

get_fq_name_str()

Return FQN of firewall-policy as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_security_logging_object_refs()

Return security-logging-object list for firewall-policy.

Returns:list of tuple <SecurityLoggingObject, SloRateType>
get_tag_refs()

Return tag list for firewall-policy.

Returns:list of <Tag>
get_type()

Return object type (firewall-policy).

id_perms

Get id-perms for firewall-policy.

Returns:IdPermsType object
perms2

Get perms2 for firewall-policy.

Returns:PermType2 object
set_firewall_rule(ref_obj, ref_data=None)

Set firewall-rule for firewall-policy.

Parameters:
  • ref_obj – FirewallRule object
  • ref_data – FirewallSequence object
set_firewall_rule_list(ref_obj_list, ref_data_list=None)

Set firewall-rule list for firewall-policy.

Parameters:
  • ref_obj_list – list of FirewallRule object
  • ref_data_list – list of FirewallSequence object
set_security_logging_object(ref_obj, ref_data=None)

Set security-logging-object for firewall-policy.

Parameters:
  • ref_obj – SecurityLoggingObject object
  • ref_data – SloRateType object
set_security_logging_object_list(ref_obj_list, ref_data_list=None)

Set security-logging-object list for firewall-policy.

Parameters:
  • ref_obj_list – list of SecurityLoggingObject object
  • ref_data_list – list of SloRateType object
set_tag(ref_obj)

Set tag for firewall-policy.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for firewall-policy.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.FirewallRule(name=None, parent_obj=None, draft_mode_state=None, action_list=None, service=None, endpoint_1=None, endpoint_2=None, match_tags=None, match_tag_types=None, direction=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

When parent is policy-management:
Firewall-rule object
When parent is project:
Project level firewall-rule object
Created By:
User when parent is PolicyManagement User when parent is Project
Child of:
PolicyManagement object OR Project object
Properties:
  • draft_mode_state

    Type: str, one-of [u’created’, u’updated’, u’deleted’]

    Created By: User (optional)

    Operations Allowed: R

    Description:

  • action_list

    Type: ActionListType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Actions to be performed if packets match condition

  • service

    Type: FirewallServiceType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Service (port, protocol) for packets match condition

  • endpoint_1

    Type: FirewallRuleEndpointType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    match condition for traffic source

  • endpoint_2

    Type: FirewallRuleEndpointType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    match condition for traffic destination

  • match_tags

    Type: FirewallRuleMatchTagsType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    matching tags for source and destination endpoints

  • match_tag_types

    Type: FirewallRuleMatchTagsTypeIdList

    Created By: User (required)

    Operations Allowed: R

    Description:

    matching tags ids for source and destination endpoints

  • direction

    Type: str, one-of [u’<’, u’>’, u’<>’]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Direction in the rule

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 ServiceGroup objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to service-group attached to this firewall policy

  • list of AddressGroup objects

    Created By: User (optional)

    Operations Allowed: R

    Description:

    Reference to address group attached to endpoints

  • list of VirtualNetwork objects

    Created By: User (optional)

    Operations Allowed: R

    Description:

    Reference to virtual network attached to endpoints

  • list of (SecurityLoggingObject object, SloRateType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to security-logging-object attached to this firewall-rule

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
action_list

Get action-list for firewall-rule.

Returns:ActionListType object
add_address_group(ref_obj)

Add address-group to firewall-rule.

Parameters:ref_obj – AddressGroup object
add_security_logging_object(ref_obj, ref_data=None)

Add security-logging-object to firewall-rule.

Parameters:
  • ref_obj – SecurityLoggingObject object
  • ref_data – SloRateType object
add_service_group(ref_obj)

Add service-group to firewall-rule.

Parameters:ref_obj – ServiceGroup object
add_tag(ref_obj)

Add tag to firewall-rule.

Parameters:ref_obj – Tag object
add_virtual_network(ref_obj)

Add virtual-network to firewall-rule.

Parameters:ref_obj – VirtualNetwork object
annotations

Get annotations for firewall-rule.

Returns:KeyValuePairs object
direction

Get direction for firewall-rule.

Returns:FirewallRuleDirectionType object
display_name

Get display-name for firewall-rule.

Returns:xsd:string object
draft_mode_state

Get draft-mode-state for firewall-rule.

Returns:DraftModeState object
dump()

Display firewall-rule object in compact form.

endpoint_1

Get endpoint-1 for firewall-rule.

Returns:FirewallRuleEndpointType object
endpoint_2

Get endpoint-2 for firewall-rule.

Returns:FirewallRuleEndpointType object
get_address_group_refs()

Return address-group list for firewall-rule.

Returns:list of <AddressGroup>
get_firewall_policy_back_refs()

Return list of all firewall-policys using this firewall-rule

get_fq_name()

Return FQN of firewall-rule in list form.

get_fq_name_str()

Return FQN of firewall-rule as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_security_logging_object_refs()

Return security-logging-object list for firewall-rule.

Returns:list of tuple <SecurityLoggingObject, SloRateType>
get_service_group_refs()

Return service-group list for firewall-rule.

Returns:list of <ServiceGroup>
get_tag_refs()

Return tag list for firewall-rule.

Returns:list of <Tag>
get_type()

Return object type (firewall-rule).

get_virtual_network_refs()

Return virtual-network list for firewall-rule.

Returns:list of <VirtualNetwork>
id_perms

Get id-perms for firewall-rule.

Returns:IdPermsType object
match_tag_types

Get match-tag-types for firewall-rule.

Returns:FirewallRuleMatchTagsTypeIdList object
match_tags

Get match-tags for firewall-rule.

Returns:FirewallRuleMatchTagsType object
perms2

Get perms2 for firewall-rule.

Returns:PermType2 object
service

Get service for firewall-rule.

Returns:FirewallServiceType object
set_address_group(ref_obj)

Set address-group for firewall-rule.

Parameters:ref_obj – AddressGroup object
set_address_group_list(ref_obj_list)

Set address-group list for firewall-rule.

Parameters:ref_obj_list – list of AddressGroup object
set_security_logging_object(ref_obj, ref_data=None)

Set security-logging-object for firewall-rule.

Parameters:
  • ref_obj – SecurityLoggingObject object
  • ref_data – SloRateType object
set_security_logging_object_list(ref_obj_list, ref_data_list=None)

Set security-logging-object list for firewall-rule.

Parameters:
  • ref_obj_list – list of SecurityLoggingObject object
  • ref_data_list – list of SloRateType object
set_service_group(ref_obj)

Set service-group for firewall-rule.

Parameters:ref_obj – ServiceGroup object
set_service_group_list(ref_obj_list)

Set service-group list for firewall-rule.

Parameters:ref_obj_list – list of ServiceGroup object
set_tag(ref_obj)

Set tag for firewall-rule.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for firewall-rule.

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

Set virtual-network for firewall-rule.

Parameters:ref_obj – VirtualNetwork object
set_virtual_network_list(ref_obj_list)

Set virtual-network list for firewall-rule.

Parameters:ref_obj_list – list of VirtualNetwork object
class 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, floating_ip_port_mappings_enable=False, floating_ip_port_mappings=None, floating_ip_traffic_direction='both', id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

When parent is floating-ip-pool:
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.
When parent is instance-ip:
floating-ip can be child of instance-ip. By doing so instance-ip can be used as floating-ip.
Created By:
User when parent is FloatingIpPool User when parent is InstanceIp
Child of:
FloatingIpPool object OR InstanceIp object
Properties:
  • floating_ip_address

    Type: str, 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: str, 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: str, one-of [u’v4’, u’v6’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Ip address family of the floating ip, IpV4 or IpV6

  • floating_ip_port_mappings_enable

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    If it is false, floating-ip Nat is done for all Ports. If it is true, floating-ip Nat is done to the

    list of PortMaps.

  • floating_ip_port_mappings

    Type: PortMappings

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of PortMaps for this floating-ip.

  • floating_ip_traffic_direction

    Type: str, one-of [u’ingress’, u’egress’, u’both’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Specifies direction of traffic for the floating-ip

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_project(ref_obj)

Add project to floating-ip.

Parameters:ref_obj – Project object
add_tag(ref_obj)

Add tag to floating-ip.

Parameters:ref_obj – Tag object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to floating-ip.

Parameters:ref_obj – VirtualMachineInterface object
annotations

Get annotations for floating-ip.

Returns:KeyValuePairs 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
floating_ip_port_mappings

Get floating-ip-port-mappings for floating-ip.

Returns:PortMappings object
floating_ip_port_mappings_enable

Get floating-ip-port-mappings-enable for floating-ip.

Returns:xsd:boolean object
floating_ip_traffic_direction

Get floating-ip-traffic-direction for floating-ip.

Returns:TrafficDirectionType 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_tag_refs()

Return tag list for floating-ip.

Returns:list of <Tag>
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_tag(ref_obj)

Set tag for floating-ip.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for floating-ip.

Parameters:ref_obj_list – list of Tag 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 gen.resource_common.FloatingIpPool(name=None, parent_obj=None, floating_ip_pool_subnets=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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.

Created By:
User
Child of:
VirtualNetwork object
Properties:
  • floating_ip_pool_subnets

    Type: FloatingIpPoolSubnetType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Subnets that restrict floating ip allocation from the corresponding virtual network.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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:
  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to floating-ip-pool.

Parameters:ref_obj – Tag object
annotations

Get annotations for floating-ip-pool.

Returns:KeyValuePairs object
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_subnets

Get floating-ip-pool-subnets for floating-ip-pool.

Returns:FloatingIpPoolSubnetType 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_tag_refs()

Return tag list for floating-ip-pool.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for floating-ip-pool.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for floating-ip-pool.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.FlowNode(name=None, parent_obj=None, flow_node_ip_address=None, flow_node_load_balancer_ip=None, flow_node_inband_interface=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Appformix flows node is object representing a logical node in system which serves xflow collectors.

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • flow_node_ip_address

    Type: str, one-of xsd:string

    Created By: User (admin-only)

    Operations Allowed: CRUD

    Description:

    Ip address of the appformix flow node, set while provisioning.

  • flow_node_load_balancer_ip

    Type: str, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    IP address of the load balancer node for xflow collectors, set while provisioning.

  • flow_node_inband_interface

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    In-Band interface name used for this flow node.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 (optional)

    Operations Allowed: CRUD

    Description:

    Similar to using virtual-machine to model the bare metal server, we are using virtual-network to

    model telemetry underlay infra network. This would allow us to re-use the same IPAM data model and

    code base to manage the IP auto-assignments for the underlay telemetry networks.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to flow-node.

Parameters:ref_obj – Tag object
add_virtual_network(ref_obj)

Add virtual-network to flow-node.

Parameters:ref_obj – VirtualNetwork object
annotations

Get annotations for flow-node.

Returns:KeyValuePairs object
display_name

Get display-name for flow-node.

Returns:xsd:string object
dump()

Display flow-node object in compact form.

flow_node_inband_interface

Get flow-node-inband-interface for flow-node.

Returns:xsd:string object
flow_node_ip_address

Get flow-node-ip-address for flow-node.

Returns:IpAddressType object
flow_node_load_balancer_ip

Get flow-node-load-balancer-ip for flow-node.

Returns:IpAddressType object
get_fq_name()

Return FQN of flow-node in list form.

get_fq_name_str()

Return FQN of flow-node as colon delimited string.

get_instance_ip_back_refs()

Return list of all instance-ips using this flow-node

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for flow-node.

Returns:list of <Tag>
get_type()

Return object type (flow-node).

get_virtual_network_refs()

Return virtual-network list for flow-node.

Returns:list of <VirtualNetwork>
id_perms

Get id-perms for flow-node.

Returns:IdPermsType object
perms2

Get perms2 for flow-node.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for flow-node.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for flow-node.

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

Set virtual-network for flow-node.

Parameters:ref_obj – VirtualNetwork object
set_virtual_network_list(ref_obj_list)

Set virtual-network list for flow-node.

Parameters:ref_obj_list – list of VirtualNetwork object
class gen.resource_common.ForwardingClass(name=None, parent_obj=None, forwarding_class_id=0, forwarding_class_dscp=None, forwarding_class_vlan_priority=None, forwarding_class_mpls_exp=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Link to global-qos config.

Created By:
User
Child of:
GlobalQosConfig object
Properties:
  • forwarding_class_id

    Type: int, within [0, 255]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Unique ID for this forwarding class.

  • forwarding_class_dscp

    Type: int, within [0, 63]

    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, within [0, 7]

    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, within [0, 7]

    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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_qos_queue(ref_obj)

Add qos-queue to forwarding-class.

Parameters:ref_obj – QosQueue object
add_tag(ref_obj)

Add tag to forwarding-class.

Parameters:ref_obj – Tag object
annotations

Get annotations for forwarding-class.

Returns:KeyValuePairs 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:DscpValueType object
forwarding_class_id

Get forwarding-class-id for forwarding-class.

Returns:ForwardingClassId object
forwarding_class_mpls_exp

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

Returns:MplsExpType object
forwarding_class_vlan_priority

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

Returns:VlanPriorityType 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_tag_refs()

Return tag list for forwarding-class.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for forwarding-class.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for forwarding-class.

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

Bases: future.types.newobject.newobject

global analytics config related data

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 StructuredSyslogConfig objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of structured-syslog-config that are applicable to objects anchored under global-

    analytics-config.

References to:
  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to global-analytics-config.

Parameters:ref_obj – Tag object
annotations

Get annotations for global-analytics-config.

Returns:KeyValuePairs object
display_name

Get display-name for global-analytics-config.

Returns:xsd:string object
dump()

Display global-analytics-config object in compact form.

get_fq_name()

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

get_fq_name_str()

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

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for global-analytics-config.

Returns:list of <Tag>
get_type()

Return object type (global-analytics-config).

id_perms

Get id-perms for global-analytics-config.

Returns:IdPermsType object
perms2

Get perms2 for global-analytics-config.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for global-analytics-config.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for global-analytics-config.

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

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • control_traffic_dscp

    Type: ControlTrafficDscpType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    DSCP value of IP header for control traffic

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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:
  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to global-qos-config.

Parameters:ref_obj – Tag object
annotations

Get annotations for global-qos-config.

Returns:KeyValuePairs object
control_traffic_dscp

Get control-traffic-dscp for global-qos-config.

Returns:ControlTrafficDscpType object
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_tag_refs()

Return tag list for global-qos-config.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for global-qos-config.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for global-qos-config.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.GlobalSystemConfig(name=None, parent_obj=None, autonomous_system=None, enable_4byte_as=False, config_version=None, graceful_restart_parameters=None, fast_convergence_parameters=None, plugin_tuning=None, data_center_interconnect_loopback_namespace=None, data_center_interconnect_asn_namespace=None, ibgp_auto_mesh=True, bgp_always_compare_med=None, rd_cluster_seed=None, ip_fabric_subnets=None, supported_device_families=None, supported_vendor_hardwares=None, bgpaas_parameters=None, mac_limit_control=None, mac_move_control=None, mac_aging_time=300, igmp_enable=False, alarm_enable=None, user_defined_log_statistics=None, enable_security_policy_draft=False, supported_fabric_annotations=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
ConfigRoot object
Properties:
  • autonomous_system

    Type: int, within [1, 4294967295]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Autonomous System number for the cluster which is 16 bits by default, but can be changed to 32 bits

    by setting enable-4byte-as.

  • enable_4byte_as

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Knob to enable 4 byte Autonomous System number support.

  • config_version

    Type: str

    Created By: System

    Operations Allowed: R

    Description:

    Version of OpenContrail software that generated this config.

  • graceful_restart_parameters

    Type: GracefulRestartParametersType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Graceful Restart parameters

  • fast_convergence_parameters

    Type: FastConvergenceParametersType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Fast Convergence parameters.

  • plugin_tuning

    Type: PluginProperties

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

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

  • data_center_interconnect_loopback_namespace

    Type: SubnetListType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Used for assigning loopback addresses on interconnect physical devices.

  • data_center_interconnect_asn_namespace

    Type: AsnRangeType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Used for assigning asn values on interconnect physical devices.

  • 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.

  • bgp_always_compare_med

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Always compare MED even if paths are received from different ASes.

  • rd_cluster_seed

    Type: int, within [1, 65535]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Used to create collision-free route distinguishers.

  • 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.

  • supported_device_families

    Type: DeviceFamilyListType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of all supported physical router device family names. Used by UI to show pick list.

  • supported_vendor_hardwares

    Type: VendorHardwaresType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of all supported vendor hardware platforms by the system. Used by UI to show pick list.

  • bgpaas_parameters

    Type: BGPaaServiceParametersType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    BGP As A Service Parameters configuration

  • mac_limit_control

    Type: MACLimitControlType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    MAC limit control on the network

  • mac_move_control

    Type: MACMoveLimitControlType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    MAC move control on the network

  • mac_aging_time

    Type: int, within [0, 86400]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    MAC aging time on the network

  • igmp_enable

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    IGMP mode at Global level.

  • 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_log_statistics

    Type: UserDefinedLogStatList

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    stats name and patterns

  • enable_security_policy_draft

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • supported_fabric_annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of supported annotations that can be used to annotate a Contrail Fabric. These annoations are

    used as directives, or hints to assign resources defined in namespaces to the network devices. For

    example, igp-protocol: ospf attribute could be used by the underlay provisioning playbook to

    choose which IGP protocol to use for the IP fabric.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 FeatureFlag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    configurable list of features allowed in this system.

  • list of ControlNodeZone objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of references to all control-node-zones in systems.

  • 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 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 FlowNode objects

    Created By: User (admin-only)

    Operations Allowed: CRUD

    Description:

    Appformix flows node is object representing a logical node in system which serves xflow collectors.

  • list of DevicemgrNode objects

    Created By: User (admin-only)

    Operations Allowed: CRUD

    Description:

    devicemgr node is object representing a logical node in system for configuring physical devices.

  • list of DatabaseNode objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

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

  • list of WebuiNode objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    WebUI node is object representing a logical node in system which hosts the Contrail UI.

  • list of ConfigDatabaseNode objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Config Database node is object representing a logical node in system which hosts Cassandra DB and

    Zookeeper for Config.

  • list of AnalyticsAlarmNode 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 AnalyticsSnmpNode 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 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.

  • list of ConfigProperties objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of config properties.

  • list of JobTemplate objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of job templates supported by the system.

  • list of DataCenterInterconnect objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of DCI Objects in the system. Each DCI represents an interconnect of Multiple Fabrics or

    interconnect of LRs in same fabric.

  • list of IntentMap objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of intent-maps in the system.

  • list of Fabric objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of fabrics in the system. Each fabric is an administrative domain for all the network devices

    in one or multiple CLOS.

  • list of NodeProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of node profiles supported by the system.

  • 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 DeviceImage objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of device image info for the images that get uploaded to the system.

  • list of Node objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Parent of this node resource.

  • list of Feature objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of features supported by the system.

  • list of PhysicalRole objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of physical roles supported by the system.

  • list of OverlayRole objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of overlay roles supported by the system.

  • list of RoleDefinition objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of role definitions supported by the system.

  • list of GlobalAnalyticsConfig objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of global-analytics-config that are 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.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_bgp_router(ref_obj)

Add bgp-router to global-system-config.

Parameters:ref_obj – BgpRouter object
add_tag(ref_obj)

Add tag to global-system-config.

Parameters:ref_obj – Tag object
alarm_enable

Get alarm-enable for global-system-config.

Returns:xsd:boolean object
annotations

Get annotations for global-system-config.

Returns:KeyValuePairs object
autonomous_system

Get autonomous-system for global-system-config.

Returns:AutonomousSystemType object
bgp_always_compare_med

Get bgp-always-compare-med for global-system-config.

Returns:xsd:boolean object
bgpaas_parameters

Get bgpaas-parameters for global-system-config.

Returns:BGPaaServiceParametersType object
config_version

Get config-version for global-system-config.

Returns:xsd:string object
data_center_interconnect_asn_namespace

Get data-center-interconnect-asn-namespace for global-system-config.

Returns:AsnRangeType object
data_center_interconnect_loopback_namespace

Get data-center-interconnect-loopback-namespace for global-system-config.

Returns:SubnetListType object
display_name

Get display-name for global-system-config.

Returns:xsd:string object
dump()

Display global-system-config object in compact form.

enable_4byte_as

Get enable-4byte-as for global-system-config.

Returns:xsd:boolean object
enable_security_policy_draft

Get enable-security-policy-draft for global-system-config.

Returns:xsd:boolean object
fast_convergence_parameters

Get fast-convergence-parameters for global-system-config.

Returns:FastConvergenceParametersType object
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_qos_config_back_refs()

Return list of all qos-configs using this global-system-config

get_tag_refs()

Return tag list for global-system-config.

Returns:list of <Tag>
get_type()

Return object type (global-system-config).

graceful_restart_parameters

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

Returns:GracefulRestartParametersType 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
igmp_enable

Get igmp-enable for global-system-config.

Returns:xsd:boolean object
ip_fabric_subnets

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

Returns:SubnetListType object
mac_aging_time

Get mac-aging-time for global-system-config.

Returns:MACAgingTime object
mac_limit_control

Get mac-limit-control for global-system-config.

Returns:MACLimitControlType object
mac_move_control

Get mac-move-control for global-system-config.

Returns:MACMoveLimitControlType object
perms2

Get perms2 for global-system-config.

Returns:PermType2 object
plugin_tuning

Get plugin-tuning for global-system-config.

Returns:PluginProperties object
rd_cluster_seed

Get rd-cluster-seed for global-system-config.

Returns:RdClusterSeedType 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
set_tag(ref_obj)

Set tag for global-system-config.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for global-system-config.

Parameters:ref_obj_list – list of Tag object
supported_device_families

Get supported-device-families for global-system-config.

Returns:DeviceFamilyListType object
supported_fabric_annotations

Get supported-fabric-annotations for global-system-config.

Returns:KeyValuePairs object
supported_vendor_hardwares

Get supported-vendor-hardwares for global-system-config.

Returns:VendorHardwaresType object
user_defined_log_statistics

Get user-defined-log-statistics for global-system-config.

Returns:UserDefinedLogStatList object
class 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, enable_security_logging=True, encryption_mode='none', encryption_tunnel_endpoints=None, forwarding_mode=None, port_translation_pools=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
GlobalSystemConfig object
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 encapsulations that vrouter will use in priority order.

  • vxlan_network_identifier_mode

    Type: str, 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.

  • enable_security_logging

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Enable or disable security-logging in the system

  • encryption_mode

    Type: str, one-of [u’none’, u’all’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Enable encryption mode

  • encryption_tunnel_endpoints

    Type: EncryptionTunnelEndpointList

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Encryption tunnel endpoints list

  • forwarding_mode

    Type: str, 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.

  • port_translation_pools

    Type: PortTranslationPools

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of Ports to be reserved for providing underlay connectivity via Port translation.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 SecurityLoggingObject objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to security logging object for global-vrouter-config.

References to:
  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to global-vrouter-config.

Parameters:ref_obj – Tag object
annotations

Get annotations for global-vrouter-config.

Returns:KeyValuePairs object
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
enable_security_logging

Get enable-security-logging for global-vrouter-config.

Returns:xsd:boolean object
encapsulation_priorities

Get encapsulation-priorities for global-vrouter-config.

Returns:EncapsulationPrioritiesType object
encryption_mode

Get encryption-mode for global-vrouter-config.

Returns:EncryptionMode object
encryption_tunnel_endpoints

Get encryption-tunnel-endpoints for global-vrouter-config.

Returns:EncryptionTunnelEndpointList 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_application_policy_set_back_refs()

Return list of all application-policy-sets using this global-vrouter-config

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_tag_refs()

Return tag list for global-vrouter-config.

Returns:list of <Tag>
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
port_translation_pools

Get port-translation-pools for global-vrouter-config.

Returns:PortTranslationPools object
set_tag(ref_obj)

Set tag for global-vrouter-config.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for global-vrouter-config.

Parameters:ref_obj_list – list of Tag object
vxlan_network_identifier_mode

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

Returns:VxlanNetworkIdentifierModeType object
class gen.resource_common.GrpcProfile(name=None, parent_obj=None, grpc_profile_is_default=False, grpc_parameters=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

This resource contains information specific to grpc parameters

Created By:
User
Child of:
Project object
Properties:
  • grpc_profile_is_default

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This attribute indicates whether it is a default grpc profile or not. Default profiles are non-

    editable.

  • grpc_parameters

    Type: GrpcParameters

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Parameters for each grpc profile, such as allow client, top level sensor options etc.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to grpc-profile.

Parameters:ref_obj – Tag object
annotations

Get annotations for grpc-profile.

Returns:KeyValuePairs object
display_name

Get display-name for grpc-profile.

Returns:xsd:string object
dump()

Display grpc-profile object in compact form.

get_fq_name()

Return FQN of grpc-profile in list form.

get_fq_name_str()

Return FQN of grpc-profile as colon delimited string.

get_parent_fq_name()

Return FQN of grpc-profile’s parent in list form.

get_parent_fq_name_str()

Return FQN of grpc-profile’s parent as colon delimted string.

get_tag_refs()

Return tag list for grpc-profile.

Returns:list of <Tag>
get_telemetry_profile_back_refs()

Return list of all telemetry-profiles using this grpc-profile

get_type()

Return object type (grpc-profile).

grpc_parameters

Get grpc-parameters for grpc-profile.

Returns:GrpcParameters object
grpc_profile_is_default

Get grpc-profile-is-default for grpc-profile.

Returns:xsd:boolean object
id_perms

Get id-perms for grpc-profile.

Returns:IdPermsType object
perms2

Get perms2 for grpc-profile.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for grpc-profile.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for grpc-profile.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.Hardware(name=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

This resource contains the information about the device hardware info. This resource name must follow the convention: ‘[vendor name]-[hardware platform name]’, for example, ‘juniper-mx80’.

Created By:

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Card objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of installed interface cards in a specific hardware platform.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_card(ref_obj)

Add card to hardware.

Parameters:ref_obj – Card object
add_tag(ref_obj)

Add tag to hardware.

Parameters:ref_obj – Tag object
annotations

Get annotations for hardware.

Returns:KeyValuePairs object
display_name

Get display-name for hardware.

Returns:xsd:string object
dump()

Display hardware object in compact form.

get_card_refs()

Return card list for hardware.

Returns:list of <Card>
get_device_image_back_refs()

Return list of all device-images using this hardware

get_fq_name()

Return FQN of hardware in list form.

get_fq_name_str()

Return FQN of hardware as colon delimited string.

get_node_profile_back_refs()

Return list of all node-profiles using this hardware

get_tag_refs()

Return tag list for hardware.

Returns:list of <Tag>
get_type()

Return object type (hardware).

id_perms

Get id-perms for hardware.

Returns:IdPermsType object
perms2

Get perms2 for hardware.

Returns:PermType2 object
set_card(ref_obj)

Set card for hardware.

Parameters:ref_obj – Card object
set_card_list(ref_obj_list)

Set card list for hardware.

Parameters:ref_obj_list – list of Card object
set_tag(ref_obj)

Set tag for hardware.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for hardware.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.HardwareInventory(name=None, parent_obj=None, hardware_inventory_inventory_info=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Hardware Inventory on a physical router.

Created By:
User
Child of:
PhysicalRouter object
Properties:
  • hardware_inventory_inventory_info

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    chassis inventory info of the physical router. Stored as json string. Will be used to render chassis

    hardware details in UI

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to hardware-inventory.

Parameters:ref_obj – Tag object
annotations

Get annotations for hardware-inventory.

Returns:KeyValuePairs object
display_name

Get display-name for hardware-inventory.

Returns:xsd:string object
dump()

Display hardware-inventory object in compact form.

get_fq_name()

Return FQN of hardware-inventory in list form.

get_fq_name_str()

Return FQN of hardware-inventory as colon delimited string.

get_parent_fq_name()

Return FQN of hardware-inventory’s parent in list form.

get_parent_fq_name_str()

Return FQN of hardware-inventory’s parent as colon delimted string.

get_tag_refs()

Return tag list for hardware-inventory.

Returns:list of <Tag>
get_type()

Return object type (hardware-inventory).

hardware_inventory_inventory_info

Get hardware-inventory-inventory-info for hardware-inventory.

Returns:xsd:string object
id_perms

Get id-perms for hardware-inventory.

Returns:IdPermsType object
perms2

Get perms2 for hardware-inventory.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for hardware-inventory.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for hardware-inventory.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.HostBasedService(name=None, parent_obj=None, host_based_service_type='firewall', id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Project level host based service.

Created By:
User
Child of:
Project object
Properties:
  • host_based_service_type

    Type: str, one-of [u’firewall’]

    Created By: User (optional)

    Operations Allowed: CR

    Description:

    Defines which host based service type is used, cannot not be updated.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 object, ServiceVirtualNetworkType attribute)

    Created By: User (optional)

    Operations Allowed: R

    Description:

    Reference to virtual network attached to the HBS tagged mangement, left, right, other*. only one ref

    per tag type.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to host-based-service.

Parameters:ref_obj – Tag object
add_virtual_network(ref_obj, ref_data=None)

Add virtual-network to host-based-service.

Parameters:
  • ref_obj – VirtualNetwork object
  • ref_data – ServiceVirtualNetworkType object
annotations

Get annotations for host-based-service.

Returns:KeyValuePairs object
display_name

Get display-name for host-based-service.

Returns:xsd:string object
dump()

Display host-based-service object in compact form.

get_fq_name()

Return FQN of host-based-service in list form.

get_fq_name_str()

Return FQN of host-based-service as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for host-based-service.

Returns:list of <Tag>
get_type()

Return object type (host-based-service).

get_virtual_network_refs()

Return virtual-network list for host-based-service.

Returns:list of tuple <VirtualNetwork, ServiceVirtualNetworkType>
host_based_service_type

Get host-based-service-type for host-based-service.

Returns:HostBasedServiceType object
id_perms

Get id-perms for host-based-service.

Returns:IdPermsType object
perms2

Get perms2 for host-based-service.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for host-based-service.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for host-based-service.

Parameters:ref_obj_list – list of Tag object
set_virtual_network(ref_obj, ref_data=None)

Set virtual-network for host-based-service.

Parameters:
  • ref_obj – VirtualNetwork object
  • ref_data – ServiceVirtualNetworkType object
set_virtual_network_list(ref_obj_list, ref_data_list=None)

Set virtual-network list for host-based-service.

Parameters:
  • ref_obj_list – list of VirtualNetwork object
  • ref_data_list – list of ServiceVirtualNetworkType object
class 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_subscriber_tag=None, instance_ip_secondary=False, instance_ip_local_ip=False, service_instance_ip=False, service_health_check_ip=False, instance_ip_subnet=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

Properties:
  • instance_ip_address

    Type: str, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CR

    Description:

    Ip address value for instance ip.

  • instance_ip_family

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

    Created By: User (optional)

    Operations Allowed: CR

    Description:

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

  • instance_ip_mode

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

    Created By: User (optional)

    Operations Allowed: CR

    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: str

    Created By: User (optional)

    Operations Allowed: CR

    Description:

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

  • instance_ip_subscriber_tag

    Type: str

    Created By: User (optional)

    Operations Allowed: CR

    Description:

    This instance ip belongs to one of the subscribers in the subscriber-tag.

  • 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

  • instance_ip_subnet

    Type: SubnetType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Ip prefix/length of the subnet where instance-ip belongs.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 can be child of instance-ip. By doing so instance-ip can be used as floating-ip.

References to:
  • list of VirtualNetwork objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Reference to virtual network of this instance ip.

  • list of NetworkIpam objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Reference to network ipam 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.

  • list of VirtualRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to virtual router of this instance ip.

  • list of LogicalInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to the logical interface that this instance ip is assigned to.

  • list of FlowNode objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to the flow node that this instance ip is assigned to.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_flow_node(ref_obj)

Add flow-node to instance-ip.

Parameters:ref_obj – FlowNode object
add_logical_interface(ref_obj)

Add logical-interface to instance-ip.

Parameters:ref_obj – LogicalInterface object
add_network_ipam(ref_obj)

Add network-ipam to instance-ip.

Parameters:ref_obj – NetworkIpam object
add_physical_router(ref_obj)

Add physical-router to instance-ip.

Parameters:ref_obj – PhysicalRouter object
add_tag(ref_obj)

Add tag to instance-ip.

Parameters:ref_obj – Tag 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
add_virtual_router(ref_obj)

Add virtual-router to instance-ip.

Parameters:ref_obj – VirtualRouter object
annotations

Get annotations for instance-ip.

Returns:KeyValuePairs object
display_name

Get display-name for instance-ip.

Returns:xsd:string object
dump()

Display instance-ip object in compact form.

get_flow_node_refs()

Return flow-node list for instance-ip.

Returns:list of <FlowNode>
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_logical_interface_refs()

Return logical-interface list for instance-ip.

Returns:list of <LogicalInterface>
get_network_ipam_refs()

Return network-ipam list for instance-ip.

Returns:list of <NetworkIpam>
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_tag_refs()

Return tag list for instance-ip.

Returns:list of <Tag>
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>
get_virtual_router_refs()

Return virtual-router list for instance-ip.

Returns:list of <VirtualRouter>
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
instance_ip_subnet

Get instance-ip-subnet for instance-ip.

Returns:SubnetType object
instance_ip_subscriber_tag

Get instance-ip-subscriber-tag for instance-ip.

Returns:xsd:string 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_flow_node(ref_obj)

Set flow-node for instance-ip.

Parameters:ref_obj – FlowNode object
set_flow_node_list(ref_obj_list)

Set flow-node list for instance-ip.

Parameters:ref_obj_list – list of FlowNode object
set_logical_interface(ref_obj)

Set logical-interface for instance-ip.

Parameters:ref_obj – LogicalInterface object
set_logical_interface_list(ref_obj_list)

Set logical-interface list for instance-ip.

Parameters:ref_obj_list – list of LogicalInterface object
set_network_ipam(ref_obj)

Set network-ipam for instance-ip.

Parameters:ref_obj – NetworkIpam object
set_network_ipam_list(ref_obj_list)

Set network-ipam list for instance-ip.

Parameters:ref_obj_list – list of NetworkIpam 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_tag(ref_obj)

Set tag for instance-ip.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for instance-ip.

Parameters:ref_obj_list – list of Tag 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
set_virtual_router(ref_obj)

Set virtual-router for instance-ip.

Parameters:ref_obj – VirtualRouter object
set_virtual_router_list(ref_obj_list)

Set virtual-router list for instance-ip.

Parameters:ref_obj_list – list of VirtualRouter object
subnet_uuid

Get subnet-uuid for instance-ip.

Returns:xsd:string object
class gen.resource_common.IntentMap(name=None, parent_obj=None, intent_map_intent_type=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

List of intent-maps in the system.

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • intent_map_intent_type

    Type: str, one-of [u’assisted-replicator’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Based on this value we determine what intent model we are serving

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to intent-map.

Parameters:ref_obj – Tag object
annotations

Get annotations for intent-map.

Returns:KeyValuePairs object
display_name

Get display-name for intent-map.

Returns:xsd:string object
dump()

Display intent-map object in compact form.

get_fabric_back_refs()

Return list of all fabrics using this intent-map

get_fq_name()

Return FQN of intent-map in list form.

get_fq_name_str()

Return FQN of intent-map as colon delimited string.

get_parent_fq_name()

Return FQN of intent-map’s parent in list form.

get_parent_fq_name_str()

Return FQN of intent-map’s parent as colon delimted string.

get_physical_router_back_refs()

Return list of all physical-routers using this intent-map

get_tag_refs()

Return tag list for intent-map.

Returns:list of <Tag>
get_type()

Return object type (intent-map).

get_virtual_network_back_refs()

Return list of all virtual-networks using this intent-map

id_perms

Get id-perms for intent-map.

Returns:IdPermsType object
intent_map_intent_type

Get intent-map-intent-type for intent-map.

Returns:IntentType object
perms2

Get perms2 for intent-map.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for intent-map.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for intent-map.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.InterfaceRouteTable(name=None, parent_obj=None, interface_route_table_routes=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
Project object
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 irrelevant.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_service_instance(ref_obj, ref_data=None)

Add service-instance to interface-route-table.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – ServiceInterfaceTag object
add_tag(ref_obj)

Add tag to interface-route-table.

Parameters:ref_obj – Tag object
annotations

Get annotations for interface-route-table.

Returns:KeyValuePairs 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_routing_policy_back_refs()

Return list of all routing-policys using this interface-route-table

get_service_instance_refs()

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

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

Return tag list for interface-route-table.

Returns:list of <Tag>
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=None)

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=None)

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

Parameters:
  • ref_obj_list – list of ServiceInstance object
  • ref_data_list – list of ServiceInterfaceTag object
set_tag(ref_obj)

Set tag for interface-route-table.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for interface-route-table.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.JobTemplate(name=None, parent_obj=None, job_template_synchronous_job=None, job_template_type=None, job_template_concurrency_level=None, job_template_playbooks=None, job_template_recovery_playbooks=None, job_template_executables=None, job_template_input_schema=None, job_template_output_schema=None, job_template_input_ui_schema=None, job_template_output_ui_schema=None, job_template_description=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

List of job templates supported by the system.

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • job_template_synchronous_job

    Type: bool

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    if set to true, the “/execute-job” action simply executes the playbook directly and wait until the

    playbook finishes. So the playbook in the synchronous job should not take long to execute. There

    will no job log or job uve being created for synchronous job. This is an optional field. If not set,

    the default value is “false”.

  • job_template_type

    Type: str, one-of [u’workflow’, u’device_operation’, u’config’, u’executable’]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    This attribute is to identify the template type. This property is mainly needed to list all generic

    device operations in the UI. There are at present 4 types. Workflow based (e.g. fabric onboarding,

    existing fabric onboarding), device operation based (standalone like e.g. device discovery, device

    import, discover role), config based (e.g. role_assignment, fabric_config) and device command based

    (for generic device operations)

  • job_template_concurrency_level

    Type: str, one-of [u’fabric’, u’device’]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    This attribute controls the number concurrent job execution against the same fabric. When this

    attribute set to “fabric”, there could only one job execution per fabric When this attribute set to

    “device”, there could be only one playbook execution running against the same device at the time.

  • job_template_playbooks

    Type: PlaybookInfoListType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    List of vendor specific playbooks that achieve the same functionality on each vendor device. All the

    vendor specific playbooks listed here share the same input/output schema defined in the job template

  • job_template_recovery_playbooks

    Type: PlaybookInfoListType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of vendor specific playbooks that can be used to recover from an error in the workflow. All the

    vendor specific playbooks listed here share the same input/output schema defined in the job template

  • job_template_executables

    Type: ExecutableInfoListType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of Executables that needs to be Executed

  • job_template_input_schema

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    JSON schema of the job input parameters which will be used to validate the job input json or

    generate UI form for user to enter the job parameters. This property stores the JSON schema content

    as string. Here is an example fo the image upgrade job template input schema:{ “$schema”: “http

    //json-schema.org/draft-06/schema#”, “title”:
     “Image upgrade input”, “type”: “object”,

    “properties”: { “image_uuid”: { “type”: “string” } }, “required”:

    [“image_uuid”]}

  • job_template_output_schema

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    JSON schema of the job output that describes the output from the job and could be used by UI to

    render the output automatically. This property stores the JSON schema content as string.

  • job_template_input_ui_schema

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    UI JSON schema of the job input that could be used by UI to render the input form with certain nice-

    to-have features like ordering of the input fields, placeholders etc. This property stores the UI

    JSON schema content as string.

  • job_template_output_ui_schema

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    UI JSON schema of the job output that could be used by UI to render the input form with certain

    nice-to-have features like ordering of the output fields etc. This property stores the UI JSON

    schema content as string.

  • job_template_description

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    A detailed description of what the job template functionality is

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to job-template.

Parameters:ref_obj – Tag object
annotations

Get annotations for job-template.

Returns:KeyValuePairs object
display_name

Get display-name for job-template.

Returns:xsd:string object
dump()

Display job-template object in compact form.

get_fq_name()

Return FQN of job-template in list form.

get_fq_name_str()

Return FQN of job-template as colon delimited string.

get_node_profile_back_refs()

Return list of all node-profiles using this job-template

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for job-template.

Returns:list of <Tag>
get_type()

Return object type (job-template).

id_perms

Get id-perms for job-template.

Returns:IdPermsType object
job_template_concurrency_level

Get job-template-concurrency-level for job-template.

Returns:JobConcurrencyLevelType object
job_template_description

Get job-template-description for job-template.

Returns:xsd:string object
job_template_executables

Get job-template-executables for job-template.

Returns:ExecutableInfoListType object
job_template_input_schema

Get job-template-input-schema for job-template.

Returns:xsd:string object
job_template_input_ui_schema

Get job-template-input-ui-schema for job-template.

Returns:xsd:string object
job_template_output_schema

Get job-template-output-schema for job-template.

Returns:xsd:string object
job_template_output_ui_schema

Get job-template-output-ui-schema for job-template.

Returns:xsd:string object
job_template_playbooks

Get job-template-playbooks for job-template.

Returns:PlaybookInfoListType object
job_template_recovery_playbooks

Get job-template-recovery-playbooks for job-template.

Returns:PlaybookInfoListType object
job_template_synchronous_job

Get job-template-synchronous-job for job-template.

Returns:xsd:boolean object
job_template_type

Get job-template-type for job-template.

Returns:JobTemplateType object
perms2

Get perms2 for job-template.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for job-template.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for job-template.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.LinkAggregationGroup(name=None, parent_obj=None, link_aggregation_group_lacp_enabled=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

List of link aggregation groups on this PRouter.

Created By:
User
Child of:
PhysicalRouter object
Properties:
  • link_aggregation_group_lacp_enabled

    Type: bool

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Flag to turn on or off Link Aggregation Control Protocol (LACP) on this link aggregation group.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    All the interfaces that belongs to the LAG. There should be exact one ref edge that points to the

    lag interface and two or more ref-edges points to the regular interfaces.

  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of virtual machine interfaces connected to this link aggregation group

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_physical_interface(ref_obj)

Add physical-interface to link-aggregation-group.

Parameters:ref_obj – PhysicalInterface object
add_tag(ref_obj)

Add tag to link-aggregation-group.

Parameters:ref_obj – Tag object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to link-aggregation-group.

Parameters:ref_obj – VirtualMachineInterface object
annotations

Get annotations for link-aggregation-group.

Returns:KeyValuePairs object
display_name

Get display-name for link-aggregation-group.

Returns:xsd:string object
dump()

Display link-aggregation-group object in compact form.

get_fq_name()

Return FQN of link-aggregation-group in list form.

get_fq_name_str()

Return FQN of link-aggregation-group as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_physical_interface_refs()

Return physical-interface list for link-aggregation-group.

Returns:list of <PhysicalInterface>
get_tag_refs()

Return tag list for link-aggregation-group.

Returns:list of <Tag>
get_type()

Return object type (link-aggregation-group).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for link-aggregation-group.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for link-aggregation-group.

Returns:IdPermsType object

Get link-aggregation-group-lacp-enabled for link-aggregation-group.

Returns:xsd:boolean object
perms2

Get perms2 for link-aggregation-group.

Returns:PermType2 object
set_physical_interface(ref_obj)

Set physical-interface for link-aggregation-group.

Parameters:ref_obj – PhysicalInterface object
set_physical_interface_list(ref_obj_list)

Set physical-interface list for link-aggregation-group.

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

Set tag for link-aggregation-group.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for link-aggregation-group.

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

Set virtual-machine-interface for link-aggregation-group.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for link-aggregation-group.

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

Bases: future.types.newobject.newobject

Loadbalancer object represents a LBaaS instance. One single Virtual IP and multiple (listeners, pools). Applicable to LBaaS V2.

Created By:
User
Child of:
Project object
Properties:
  • loadbalancer_properties

    Type: LoadbalancerType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

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

  • loadbalancer_provider

    Type: str

    Created By: User (optional)

    Operations Allowed: CR

    Description:

    Provider field selects backend provider of the LBaaS, Cloudadmin could offer 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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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:

  • 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.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_service_appliance_set(ref_obj)

Add service-appliance-set to loadbalancer.

Parameters:ref_obj – ServiceApplianceSet object
add_service_instance(ref_obj)

Add service-instance to loadbalancer.

Parameters:ref_obj – ServiceInstance object
add_tag(ref_obj)

Add tag to loadbalancer.

Parameters:ref_obj – Tag object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to loadbalancer.

Parameters:ref_obj – VirtualMachineInterface object
annotations

Get annotations for loadbalancer.

Returns:KeyValuePairs 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_appliance_set_refs()

Return service-appliance-set list for loadbalancer.

Returns:list of <ServiceApplianceSet>
get_service_instance_refs()

Return service-instance list for loadbalancer.

Returns:list of <ServiceInstance>
get_tag_refs()

Return tag list for loadbalancer.

Returns:list of <Tag>
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_appliance_set(ref_obj)

Set service-appliance-set for loadbalancer.

Parameters:ref_obj – ServiceApplianceSet object
set_service_appliance_set_list(ref_obj_list)

Set service-appliance-set list for loadbalancer.

Parameters:ref_obj_list – list of ServiceApplianceSet 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_tag(ref_obj)

Set tag for loadbalancer.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for loadbalancer.

Parameters:ref_obj_list – list of Tag 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 gen.resource_common.LoadbalancerHealthmonitor(name=None, parent_obj=None, loadbalancer_healthmonitor_properties=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
Project object
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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to loadbalancer-healthmonitor.

Parameters:ref_obj – Tag object
annotations

Get annotations for loadbalancer-healthmonitor.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for loadbalancer-healthmonitor.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for loadbalancer-healthmonitor.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for loadbalancer-healthmonitor.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.LoadbalancerListener(name=None, parent_obj=None, loadbalancer_listener_properties=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
Project object
Properties:
  • loadbalancer_listener_properties

    Type: LoadbalancerListenerType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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:

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_loadbalancer(ref_obj)

Add loadbalancer to loadbalancer-listener.

Parameters:ref_obj – Loadbalancer object
add_tag(ref_obj)

Add tag to loadbalancer-listener.

Parameters:ref_obj – Tag object
annotations

Get annotations for loadbalancer-listener.

Returns:KeyValuePairs 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_tag_refs()

Return tag list for loadbalancer-listener.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for loadbalancer-listener.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for loadbalancer-listener.

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

Bases: future.types.newobject.newobject

Configuration object representing each member of load balancer pool.

Created By:
User
Child of:
LoadbalancerPool object
Properties:
  • loadbalancer_member_properties

    Type: LoadbalancerMemberType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

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

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to loadbalancer-member.

Parameters:ref_obj – Tag object
annotations

Get annotations for loadbalancer-member.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for loadbalancer-member.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for loadbalancer-member.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for loadbalancer-member.

Parameters:ref_obj_list – list of Tag object
class 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, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
Project object
Properties:
  • loadbalancer_pool_properties

    Type: LoadbalancerPoolType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Configuration for loadbalancer pool like protocol, subnet, etc.

  • loadbalancer_pool_provider

    Type: str

    Created By: User (optional)

    Operations Allowed: CR

    Description:

    Provider field selects backend provider of the LBaaS, Cloudadmin could offer 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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 loadbalancer listener served by this pool, applicable 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.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

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_tag(ref_obj)

Add tag to loadbalancer-pool.

Parameters:ref_obj – Tag object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to loadbalancer-pool.

Parameters:ref_obj – VirtualMachineInterface object
annotations

Get annotations for loadbalancer-pool.

Returns:KeyValuePairs 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_tag_refs()

Return tag list for loadbalancer-pool.

Returns:list of <Tag>
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_tag(ref_obj)

Set tag for loadbalancer-pool.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for loadbalancer-pool.

Parameters:ref_obj_list – list of Tag 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 gen.resource_common.LogicalInterface(name=None, parent_obj=None, logical_interface_vlan_tag=None, logical_interface_port_params=None, logical_interface_type=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

When parent is physical-router:
Logical interfaces on physical routers.
When parent is physical-interface:
Logical interfaces on physical interface on physical routers.
Created By:
User when parent is PhysicalRouter User when parent is PhysicalInterface
Child of:
PhysicalRouter object OR PhysicalInterface object
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_port_params

    Type: PortParameters

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    User can select this option to configure port parameters such as description, MTU and port enable or

    disable.

  • logical_interface_type

    Type: str, 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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 reachable by this

    logical interface.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to logical-interface.

Parameters:ref_obj – Tag object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to logical-interface.

Parameters:ref_obj – VirtualMachineInterface object
annotations

Get annotations for logical-interface.

Returns:KeyValuePairs 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_instance_ip_back_refs()

Return list of all instance-ips using this logical-interface

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_tag_refs()

Return tag list for logical-interface.

Returns:list of <Tag>
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_port_params

Get logical-interface-port-params for logical-interface.

Returns:PortParameters 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_tag(ref_obj)

Set tag for logical-interface.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for logical-interface.

Parameters:ref_obj_list – list of Tag 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 gen.resource_common.LogicalRouter(name=None, parent_obj=None, configured_route_target_list=None, vxlan_network_identifier=None, logical_router_dhcp_relay_server=None, logical_router_gateway_external=None, logical_router_type='snat-routing', id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
Project object
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.

  • vxlan_network_identifier

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    The VNI that needs to be associated with the internal VN if vxlan_routing mode is enabled.

  • logical_router_dhcp_relay_server

    Type: IpAddressesType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    DHCP server IP(s) to serve managed BMS(s).

  • logical_router_gateway_external

    Type: bool

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    this logical router is used for external connectivity or not.

  • logical_router_type

    Type: str, one-of [u’snat-routing’, u’vxlan-routing’]

    Created By: User (optional)

    Operations Allowed: CRD

    Description:

    Type of logical-router, used to signify the purpose of the logical-router.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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:

    Reference 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 object, LogicalRouterVirtualNetworkType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to a virtual network. Please refer to link attribute for additional details

  • list of ServiceInstance objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Reference to service instance doing SNAT functionality for external gateway.

  • list of PhysicalRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to physical router, when this link is present device manager configures logical router

    associated route targets/interfaces on the Physical Router.

  • list of Fabric objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to fabric, this link enables to identify which fabric, the device this LR belongs to is

    on.

  • list of Bgpvpn objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Back reference to logical router associated to the BGP VPN resource

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_bgpvpn(ref_obj)

Add bgpvpn to logical-router.

Parameters:ref_obj – Bgpvpn object
add_fabric(ref_obj)

Add fabric to logical-router.

Parameters:ref_obj – Fabric object
add_physical_router(ref_obj)

Add physical-router to logical-router.

Parameters:ref_obj – PhysicalRouter object
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_tag(ref_obj)

Add tag to logical-router.

Parameters:ref_obj – Tag object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to logical-router.

Parameters:ref_obj – VirtualMachineInterface object
add_virtual_network(ref_obj, ref_data=None)

Add virtual-network to logical-router.

Parameters:
  • ref_obj – VirtualNetwork object
  • ref_data – LogicalRouterVirtualNetworkType object
annotations

Get annotations for logical-router.

Returns:KeyValuePairs 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_bgpvpn_refs()

Return bgpvpn list for logical-router.

Returns:list of <Bgpvpn>
get_data_center_interconnect_back_refs()

Return list of all data-center-interconnects using this logical-router

get_fabric_refs()

Return fabric list for logical-router.

Returns:list of <Fabric>
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_physical_router_refs()

Return physical-router list for logical-router.

Returns:list of <PhysicalRouter>
get_port_tuple_back_refs()

Return list of all port-tuples using this logical-router

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_tag_refs()

Return tag list for logical-router.

Returns:list of <Tag>
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 tuple <VirtualNetwork, LogicalRouterVirtualNetworkType>
id_perms

Get id-perms for logical-router.

Returns:IdPermsType object
logical_router_dhcp_relay_server

Get logical-router-dhcp-relay-server for logical-router.

Returns:IpAddressesType object
logical_router_gateway_external

Get logical-router-gateway-external for logical-router.

Returns:xsd:boolean object
logical_router_type

Get logical-router-type for logical-router.

Returns:LogicalRouterType object
perms2

Get perms2 for logical-router.

Returns:PermType2 object
set_bgpvpn(ref_obj)

Set bgpvpn for logical-router.

Parameters:ref_obj – Bgpvpn object
set_bgpvpn_list(ref_obj_list)

Set bgpvpn list for logical-router.

Parameters:ref_obj_list – list of Bgpvpn object
set_fabric(ref_obj)

Set fabric for logical-router.

Parameters:ref_obj – Fabric object
set_fabric_list(ref_obj_list)

Set fabric list for logical-router.

Parameters:ref_obj_list – list of Fabric object
set_physical_router(ref_obj)

Set physical-router for logical-router.

Parameters:ref_obj – PhysicalRouter object
set_physical_router_list(ref_obj_list)

Set physical-router list for logical-router.

Parameters:ref_obj_list – list of PhysicalRouter 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_tag(ref_obj)

Set tag for logical-router.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for logical-router.

Parameters:ref_obj_list – list of Tag 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, ref_data=None)

Set virtual-network for logical-router.

Parameters:
  • ref_obj – VirtualNetwork object
  • ref_data – LogicalRouterVirtualNetworkType object
set_virtual_network_list(ref_obj_list, ref_data_list=None)

Set virtual-network list for logical-router.

Parameters:
  • ref_obj_list – list of VirtualNetwork object
  • ref_data_list – list of LogicalRouterVirtualNetworkType object
vxlan_network_identifier

Get vxlan-network-identifier for logical-router.

Returns:xsd:string object
class gen.resource_common.MulticastPolicy(name=None, parent_obj=None, multicast_source_groups=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
Project object
Properties:
  • multicast_source_groups

    Type: MulticastSourceGroups

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of Multicast (S,G) Addresses.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to multicast-policy.

Parameters:ref_obj – Tag object
annotations

Get annotations for multicast-policy.

Returns:KeyValuePairs object
display_name

Get display-name for multicast-policy.

Returns:xsd:string object
dump()

Display multicast-policy object in compact form.

get_fq_name()

Return FQN of multicast-policy in list form.

get_fq_name_str()

Return FQN of multicast-policy as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for multicast-policy.

Returns:list of <Tag>
get_type()

Return object type (multicast-policy).

get_virtual_network_back_refs()

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

id_perms

Get id-perms for multicast-policy.

Returns:IdPermsType object
multicast_source_groups

Get multicast-source-groups for multicast-policy.

Returns:MulticastSourceGroups object
perms2

Get perms2 for multicast-policy.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for multicast-policy.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for multicast-policy.

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

Bases: future.types.newobject.newobject

Namespace is unique networking namespace within this domain. If namespace is not present then default namespace of default project is used.

Created By:
User
Child of:
Domain object
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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to namespace.

Parameters:ref_obj – Tag object
annotations

Get annotations for namespace.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for namespace.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for namespace.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for namespace.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.NetconfProfile(name=None, parent_obj=None, netconf_profile_is_default=False, netconf_parameters=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

This resource contains information specific to netconf parameters

Created By:
User
Child of:
Project object
Properties:
  • netconf_profile_is_default

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This attribute indicates whether it is a default netconf profile or not. Default profiles are non-

    editable.

  • netconf_parameters

    Type: NetconfParameters

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Parameters for each netconf profile like the top level sensor options etc.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to netconf-profile.

Parameters:ref_obj – Tag object
annotations

Get annotations for netconf-profile.

Returns:KeyValuePairs object
display_name

Get display-name for netconf-profile.

Returns:xsd:string object
dump()

Display netconf-profile object in compact form.

get_fq_name()

Return FQN of netconf-profile in list form.

get_fq_name_str()

Return FQN of netconf-profile as colon delimited string.

get_parent_fq_name()

Return FQN of netconf-profile’s parent in list form.

get_parent_fq_name_str()

Return FQN of netconf-profile’s parent as colon delimted string.

get_tag_refs()

Return tag list for netconf-profile.

Returns:list of <Tag>
get_telemetry_profile_back_refs()

Return list of all telemetry-profiles using this netconf-profile

get_type()

Return object type (netconf-profile).

id_perms

Get id-perms for netconf-profile.

Returns:IdPermsType object
netconf_parameters

Get netconf-parameters for netconf-profile.

Returns:NetconfParameters object
netconf_profile_is_default

Get netconf-profile-is-default for netconf-profile.

Returns:xsd:boolean object
perms2

Get perms2 for netconf-profile.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for netconf-profile.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for netconf-profile.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.NetworkDeviceConfig(name=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 PhysicalRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Network device config of a physical router.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_physical_router(ref_obj)

Add physical-router to network-device-config.

Parameters:ref_obj – PhysicalRouter object
add_tag(ref_obj)

Add tag to network-device-config.

Parameters:ref_obj – Tag object
annotations

Get annotations for network-device-config.

Returns:KeyValuePairs object
display_name

Get display-name for network-device-config.

Returns:xsd:string object
dump()

Display network-device-config object in compact form.

get_fq_name()

Return FQN of network-device-config in list form.

get_fq_name_str()

Return FQN of network-device-config as colon delimited string.

get_physical_router_refs()

Return physical-router list for network-device-config.

Returns:list of <PhysicalRouter>
get_tag_refs()

Return tag list for network-device-config.

Returns:list of <Tag>
get_type()

Return object type (network-device-config).

id_perms

Get id-perms for network-device-config.

Returns:IdPermsType object
perms2

Get perms2 for network-device-config.

Returns:PermType2 object
set_physical_router(ref_obj)

Set physical-router for network-device-config.

Parameters:ref_obj – PhysicalRouter object
set_physical_router_list(ref_obj_list)

Set physical-router list for network-device-config.

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

Set tag for network-device-config.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for network-device-config.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.NetworkIpam(name=None, parent_obj=None, network_ipam_mgmt=None, ipam_subnets=None, ipam_subnet_method=None, ipam_subnetting=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
Project object
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: str, 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.

  • ipam_subnetting

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRD

    Description:

    This flag indicates if ipam subnets are carved out from a big subnet, default behavior is False.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to network-ipam.

Parameters:ref_obj – Tag object
add_virtual_DNS(ref_obj)

Add virtual-DNS to network-ipam.

Parameters:ref_obj – VirtualDns object
annotations

Get annotations for network-ipam.

Returns:KeyValuePairs 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_instance_ip_back_refs()

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

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_tag_refs()

Return tag list for network-ipam.

Returns:list of <Tag>
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

get_virtual_router_back_refs()

Return list of all virtual-routers 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
ipam_subnetting

Get ipam-subnetting for network-ipam.

Returns:xsd:boolean object
network_ipam_mgmt

Get network-ipam-mgmt for network-ipam.

Returns:IpamType object
perms2

Get perms2 for network-ipam.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for network-ipam.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for network-ipam.

Parameters:ref_obj_list – list of Tag 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 gen.resource_common.NetworkPolicy(name=None, parent_obj=None, network_policy_entries=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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.

Created By:
User
Child of:
Project object
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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to network-policy.

Parameters:ref_obj – Tag object
annotations

Get annotations for network-policy.

Returns:KeyValuePairs object
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_security_logging_object_back_refs()

Return list of all security-logging-objects using this network-policy

get_tag_refs()

Return tag list for network-policy.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for network-policy.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for network-policy.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.Node(name=None, parent_obj=None, node_type=None, esxi_info=None, ip_address=None, hostname=None, bms_info=None, mac_address=None, disk_partition=None, interface_name=None, cloud_info=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Parent of this node resource.

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • node_type

    Type: str, one-of [u’private’, u’baremetal’, u’esxi’, u’ovs-compute’, u’sriov-compute’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Type of machine resource

  • esxi_info

    Type: ESXIHostInfo

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Details of the ESXI host

  • ip_address

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    IP Address of the Management interface

  • hostname

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Fully qualified host name

  • bms_info

    Type: BaremetalServerInfo

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Details of the baremetal server

  • mac_address

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Provisioning Interface MAC Address

  • disk_partition

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Comma seperated disk partition to use.

  • interface_name

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Name of the Management interface

  • cloud_info

    Type: CloudInstanceInfo

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Information related to cloud

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Port objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Parent of this port.

  • list of PortGroup objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Parent of this port group.

References to:
  • list of NodeProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to matching node-profile object for this node

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_node_profile(ref_obj)

Add node-profile to node.

Parameters:ref_obj – NodeProfile object
add_tag(ref_obj)

Add tag to node.

Parameters:ref_obj – Tag object
annotations

Get annotations for node.

Returns:KeyValuePairs object
bms_info

Get bms-info for node.

Returns:BaremetalServerInfo object
cloud_info

Get cloud-info for node.

Returns:CloudInstanceInfo object
disk_partition

Get disk-partition for node.

Returns:xsd:string object
display_name

Get display-name for node.

Returns:xsd:string object
dump()

Display node object in compact form.

esxi_info

Get esxi-info for node.

Returns:ESXIHostInfo object
get_fq_name()

Return FQN of node in list form.

get_fq_name_str()

Return FQN of node as colon delimited string.

get_node_profile_refs()

Return node-profile list for node.

Returns:list of <NodeProfile>
get_parent_fq_name()

Return FQN of node’s parent in list form.

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for node.

Returns:list of <Tag>
get_type()

Return object type (node).

hostname

Get hostname for node.

Returns:xsd:string object
id_perms

Get id-perms for node.

Returns:IdPermsType object
interface_name

Get interface-name for node.

Returns:xsd:string object
ip_address

Get ip-address for node.

Returns:xsd:string object
mac_address

Get mac-address for node.

Returns:xsd:string object
node_type

Get node_type for node.

Returns:NodeType object
perms2

Get perms2 for node.

Returns:PermType2 object
set_node_profile(ref_obj)

Set node-profile for node.

Parameters:ref_obj – NodeProfile object
set_node_profile_list(ref_obj_list)

Set node-profile list for node.

Parameters:ref_obj_list – list of NodeProfile object
set_tag(ref_obj)

Set tag for node.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for node.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.NodeProfile(name=None, parent_obj=None, node_profile_type='physical-router', node_profile_vendor=None, node_profile_device_family=None, node_profile_hitless_upgrade=None, node_profile_roles=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Node profile contains the meta-data to profile/categorize the devices so that a list of supported capabilities/roles by the device are known to the system. For example, we can define a node profile to specify list of capabilities/roles supported by a set of QFX10K devices with certain hardware/software installed. It also contains the default config parameter values for each supported roles/capability. These are the config parameters that are not modeled in the VNC data model. They could be vendor specific config parameters that we allow user to tweak via API or some kind of auto generated UI from job template input schema. The UML diagram for node-profile can be found at https://github.com/jnpr-tjiang/cfm-data-model/blob/master/5.0.1-data-model/images/node_profile.png

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • node_profile_type

    Type: str, one-of [u’physical-router’, u’end-system’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Node profile type to differentiate the node profile network devices from server node profiles.

  • node_profile_vendor

    Type: str

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Vendor name (e.g. Juniper) that this node profile can be used for.

  • node_profile_device_family

    Type: str

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Device family name that this node profile can be used to match.

  • node_profile_hitless_upgrade

    Type: bool

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    if set to false, do not perform hitless image upgrade on devices using this node profile

  • node_profile_roles

    Type: NodeProfileRolesType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    List of capable physical and routing-bridging role combinations supported by the devices that

    matches one of the hardware list defined in this node profile.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 RoleConfig objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of role configs for those physical or routing/bridging roles defined in the node-profile.

References to:
  • list of JobTemplate objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This reference associates the node profile to a job-template that contains a playbook that generates

    device specific role config and deploys it to the device. The role-config.config

    attribtue value must be in JSON format and conform to the input_schema defined in the

    job-template.

  • list of Hardware objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Hardware info defined in a node profile that are used to categorize the devices

  • list of RoleDefinition objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of role definitions supported for this node profile

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_hardware(ref_obj)

Add hardware to node-profile.

Parameters:ref_obj – Hardware object
add_job_template(ref_obj)

Add job-template to node-profile.

Parameters:ref_obj – JobTemplate object
add_role_definition(ref_obj)

Add role-definition to node-profile.

Parameters:ref_obj – RoleDefinition object
add_tag(ref_obj)

Add tag to node-profile.

Parameters:ref_obj – Tag object
annotations

Get annotations for node-profile.

Returns:KeyValuePairs object
display_name

Get display-name for node-profile.

Returns:xsd:string object
dump()

Display node-profile object in compact form.

get_fabric_back_refs()

Return list of all fabrics using this node-profile

get_fq_name()

Return FQN of node-profile in list form.

get_fq_name_str()

Return FQN of node-profile as colon delimited string.

get_hardware_refs()

Return hardware list for node-profile.

Returns:list of <Hardware>
get_job_template_refs()

Return job-template list for node-profile.

Returns:list of <JobTemplate>
get_node_back_refs()

Return list of all nodes using this node-profile

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_physical_router_back_refs()

Return list of all physical-routers using this node-profile

get_role_definition_refs()

Return role-definition list for node-profile.

Returns:list of <RoleDefinition>
get_tag_refs()

Return tag list for node-profile.

Returns:list of <Tag>
get_type()

Return object type (node-profile).

id_perms

Get id-perms for node-profile.

Returns:IdPermsType object
node_profile_device_family

Get node-profile-device-family for node-profile.

Returns:xsd:string object
node_profile_hitless_upgrade

Get node-profile-hitless-upgrade for node-profile.

Returns:xsd:boolean object
node_profile_roles

Get node-profile-roles for node-profile.

Returns:NodeProfileRolesType object
node_profile_type

Get node-profile-type for node-profile.

Returns:NodeProfileType object
node_profile_vendor

Get node-profile-vendor for node-profile.

Returns:xsd:string object
perms2

Get perms2 for node-profile.

Returns:PermType2 object
set_hardware(ref_obj)

Set hardware for node-profile.

Parameters:ref_obj – Hardware object
set_hardware_list(ref_obj_list)

Set hardware list for node-profile.

Parameters:ref_obj_list – list of Hardware object
set_job_template(ref_obj)

Set job-template for node-profile.

Parameters:ref_obj – JobTemplate object
set_job_template_list(ref_obj_list)

Set job-template list for node-profile.

Parameters:ref_obj_list – list of JobTemplate object
set_role_definition(ref_obj)

Set role-definition for node-profile.

Parameters:ref_obj – RoleDefinition object
set_role_definition_list(ref_obj_list)

Set role-definition list for node-profile.

Parameters:ref_obj_list – list of RoleDefinition object
set_tag(ref_obj)

Set tag for node-profile.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for node-profile.

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

Bases: future.types.newobject.newobject

Defines an overlay role

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to overlay-role.

Parameters:ref_obj – Tag object
annotations

Get annotations for overlay-role.

Returns:KeyValuePairs object
display_name

Get display-name for overlay-role.

Returns:xsd:string object
dump()

Display overlay-role object in compact form.

get_fq_name()

Return FQN of overlay-role in list form.

get_fq_name_str()

Return FQN of overlay-role as colon delimited string.

get_parent_fq_name()

Return FQN of overlay-role’s parent in list form.

get_parent_fq_name_str()

Return FQN of overlay-role’s parent as colon delimted string.

get_physical_router_back_refs()

Return list of all physical-routers using this overlay-role

get_role_definition_back_refs()

Return list of all role-definitions using this overlay-role

get_tag_refs()

Return tag list for overlay-role.

Returns:list of <Tag>
get_type()

Return object type (overlay-role).

id_perms

Get id-perms for overlay-role.

Returns:IdPermsType object
perms2

Get perms2 for overlay-role.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for overlay-role.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for overlay-role.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.PeeringPolicy(name=None, peering_service=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

Properties:
  • peering_service

    Type: str, one-of [u’public-peering’]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Peering policy service type.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to peering-policy.

Parameters:ref_obj – Tag object
annotations

Get annotations for peering-policy.

Returns:KeyValuePairs object
display_name

Get display-name for peering-policy.

Returns:xsd:string object
dump()

Display peering-policy object in compact form.

get_e2_service_provider_back_refs()

Return list of all e2-service-providers using this peering-policy

get_fq_name()

Return FQN of peering-policy in list form.

get_fq_name_str()

Return FQN of peering-policy as colon delimited string.

get_tag_refs()

Return tag list for peering-policy.

Returns:list of <Tag>
get_type()

Return object type (peering-policy).

id_perms

Get id-perms for peering-policy.

Returns:IdPermsType object
peering_service

Get peering-service for peering-policy.

Returns:PeeringServiceType object
perms2

Get perms2 for peering-policy.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for peering-policy.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for peering-policy.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.PhysicalInterface(name=None, parent_obj=None, ethernet_segment_identifier=None, physical_interface_type=None, physical_interface_mac_addresses=None, physical_interface_port_id=None, physical_interface_flow_control=False, physical_interface_lacp_force_up=False, physical_interface_port_params=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Physical interfaces on physical routers.

Created By:
User
Child of:
PhysicalRouter object
Properties:
  • ethernet_segment_identifier

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Ethernet Segment Id configured for the Physical Interface. In a multihomed environment, user should

    configure the peer Physical interface with the same ESI.

  • physical_interface_type

    Type: str, one-of [u’regular’, u’lag’, u’service’, u’fabric’, u’access’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Physical interface type that can be either regular/LAG/service/fabric/access link.

  • physical_interface_mac_addresses

    Type: MacAddressesType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    MAC addresses on this physical interface.

  • physical_interface_port_id

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    port id of this physical interface. This port id is used in LLDP to identify a physical port on the

    peering device

  • physical_interface_flow_control

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    User can enable this option to configure flow control on the physical interface.

  • physical_interface_lacp_force_up

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    User can enable this option to make LACP up and running. This is applicable only on individual

    member physical interfaces of a VPG.

  • physical_interface_port_params

    Type: PortParameters

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    User can select this option to configure port parameters such as description, MTU and port enable or

    disable.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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.

  • list of Port objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This link represents physical connection from access port of a switch to the server port

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_physical_interface(ref_obj)

Add physical-interface to physical-interface.

Parameters:ref_obj – PhysicalInterface object
add_port(ref_obj)

Add port to physical-interface.

Parameters:ref_obj – Port object
add_tag(ref_obj)

Add tag to physical-interface.

Parameters:ref_obj – Tag object
annotations

Get annotations for physical-interface.

Returns:KeyValuePairs object
display_name

Get display-name for physical-interface.

Returns:xsd:string object
dump()

Display physical-interface object in compact form.

ethernet_segment_identifier

Get ethernet-segment-identifier for physical-interface.

Returns:xsd:string object
get_fq_name()

Return FQN of physical-interface in list form.

get_fq_name_str()

Return FQN of physical-interface as colon delimited string.

Return list of all link-aggregation-groups using this physical-interface

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_port_refs()

Return port list for physical-interface.

Returns:list of <Port>
get_service_appliance_back_refs()

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

get_tag_refs()

Return tag list for physical-interface.

Returns:list of <Tag>
get_type()

Return object type (physical-interface).

get_virtual_machine_interface_back_refs()

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

get_virtual_port_group_back_refs()

Return list of all virtual-port-groups using this physical-interface

id_perms

Get id-perms for physical-interface.

Returns:IdPermsType object
perms2

Get perms2 for physical-interface.

Returns:PermType2 object
physical_interface_flow_control

Get physical-interface-flow-control for physical-interface.

Returns:xsd:boolean object
physical_interface_lacp_force_up

Get physical-interface-lacp-force-up for physical-interface.

Returns:xsd:boolean object
physical_interface_mac_addresses

Get physical-interface-mac-addresses for physical-interface.

Returns:MacAddressesType object
physical_interface_port_id

Get physical-interface-port-id for physical-interface.

Returns:xsd:string object
physical_interface_port_params

Get physical-interface-port-params for physical-interface.

Returns:PortParameters object
physical_interface_type

Get physical-interface-type for physical-interface.

Returns:PhysicalInterfaceType 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
set_port(ref_obj)

Set port for physical-interface.

Parameters:ref_obj – Port object
set_port_list(ref_obj_list)

Set port list for physical-interface.

Parameters:ref_obj_list – list of Port object
set_tag(ref_obj)

Set tag for physical-interface.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for physical-interface.

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

Bases: future.types.newobject.newobject

Defines a physical role

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to physical-role.

Parameters:ref_obj – Tag object
annotations

Get annotations for physical-role.

Returns:KeyValuePairs object
display_name

Get display-name for physical-role.

Returns:xsd:string object
dump()

Display physical-role object in compact form.

get_device_functional_group_back_refs()

Return list of all device-functional-groups using this physical-role

get_fq_name()

Return FQN of physical-role in list form.

get_fq_name_str()

Return FQN of physical-role as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_physical_router_back_refs()

Return list of all physical-routers using this physical-role

get_role_definition_back_refs()

Return list of all role-definitions using this physical-role

get_tag_refs()

Return tag list for physical-role.

Returns:list of <Tag>
get_type()

Return object type (physical-role).

id_perms

Get id-perms for physical-role.

Returns:IdPermsType object
perms2

Get perms2 for physical-role.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for physical-role.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for physical-role.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.PhysicalRouter(name=None, parent_obj=None, physical_router_junos_service_ports=None, telemetry_info=None, physical_router_device_family=None, physical_router_os_version=None, physical_router_hostname=None, physical_router_management_ip=None, physical_router_management_mac=None, physical_router_dataplane_ip=None, physical_router_loopback_ip=None, physical_router_replicator_loopback_ip=None, physical_router_vendor_name=None, physical_router_product_name=None, physical_router_serial_number=None, physical_router_vnc_managed=None, physical_router_underlay_managed=False, physical_router_role=None, routing_bridging_roles=None, physical_router_snmp=None, physical_router_lldp=None, physical_router_user_credentials=None, physical_router_encryption_type=None, physical_router_snmp_credentials=None, physical_router_dhcp_parameters=None, physical_router_cli_commit_state='in_sync', physical_router_managed_state='active', physical_router_onboarding_state=None, physical_router_underlay_config=None, physical_router_supplemental_config=None, physical_router_autonomous_system=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Physical router object represent any physical device that participates in virtual networking, like routers, switches, servers, firewalls etc.

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • physical_router_junos_service_ports

    Type: JunosServicePorts

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

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

  • telemetry_info

    Type: TelemetryStateInfo

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Telemetry info of router. Check TelemetryStateInfo

  • physical_router_device_family

    Type: str

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Device family that this physical router is part of. It is used by the device manager to choose the

    device family specific Ansible playbooks for device management

  • physical_router_os_version

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    os version for this physical router. It is updated when device is imported or device image is

    successfully upgraded

  • physical_router_hostname

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Device host name that can be either discovered during via fabric on-boarding workflow or manually

    set by the user

  • physical_router_management_ip

    Type: str, 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_management_mac

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Management mac for this physical router.

  • physical_router_dataplane_ip

    Type: str, 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 plane by physical

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

  • physical_router_loopback_ip

    Type: str, one-of xsd:string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This is ip address of loopback interface of physical router. Used by the device manager to configure

    physical router loopback interface.

  • physical_router_replicator_loopback_ip

    Type: str, one-of xsd:string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This is the loopback ip address for assisted replication. Used by the device manager to configure

    physical router replicator ip.

  • physical_router_vendor_name

    Type: str

    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: str

    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_serial_number

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Serial number for the physical device that is used by device manager to identify the device during

    device discovery.

  • 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_underlay_managed

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Set to true if underlay is configured by device manager. The greenfield ZTP workflow sets this

    attribute to true. The brownfield on-boarding sets this attribute to false.

  • physical_router_role

    Type: str, one-of [u’spine’, u’leaf’, u’e2-access’, u’e2-provider’, u’e2-internet’, u’e2-vrr’, u’pnf’, u’superspine’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Physical router role (e.g spine or leaf), used by the device manager to provision physical router,

    for e.g device manager may choose to configure physical router based on its role.

  • routing_bridging_roles

    Type: RoutingBridgingRolesType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Routing-bridging role (e.g. CRB, ERB, etc.), used by the device manager to provision physical

    router, for e.g device manager may choose to configure physical router based on its role.

  • physical_router_snmp

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    SNMP support on this router

  • physical_router_lldp

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    LLDP support on this router

  • 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_encryption_type

    Type: str, one-of [u’none’, u’local’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Type of encryption used for physical-router-user-credentials.

  • physical_router_snmp_credentials

    Type: SNMPCredentials

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    SNMP credentials for the physical router used by SNMP collector.

  • physical_router_dhcp_parameters

    Type: DnsmasqLeaseParameters

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dnsmasq lease parameters for the physical router.

  • physical_router_cli_commit_state

    Type: str, one-of [u’in_sync’, u’out_of_sync’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    CLI commit state for the physical router. Used to check if device is in sync with Contrail managed

    configs

  • physical_router_managed_state

    Type: str, one-of [u’dhcp’, u’rma’, u’activating’, u’active’, u’maintenance’, u’error’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Managed state for the physical router. Used to RMA devices

  • physical_router_onboarding_state

    Type: str, one-of [u’discovered’, u’interfaces_onboarded’, u’topology_discovered’, u’role_discovered’, u’underlay_configured’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Onboarding state for the physical router. These states are updated during the ZTP/Brownfield of the

    device such as discovered, interface onboarded, topology discovered, underlay configured and others

  • physical_router_underlay_config

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Brownfield device underlay configuration stored during underlay onboarding. Only valid if physical-

    router-underlay-managed is false

  • physical_router_supplemental_config

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Supplemental configuration stored during ZTP onboarding.

  • physical_router_autonomous_system

    Type: AutonomousSystemsType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Autonomous system configured on the device represented by the physical router.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 LinkAggregationGroup objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of link aggregation groups on this PRouter.

  • list of HardwareInventory objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Hardware Inventory on a physical router.

  • list of CliConfig objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    CLI commits done on a physical router.

  • 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:

    Reference to vrouter responsible for this physical router. Currently only applicable for vrouters

    that are TOR agents.

  • list of BgpRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference 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.

  • list of IntentMap objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    The Physical Routers on which the config needs to be pushed

  • list of Fabric objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Fabric that this physical-router belongs to.

  • list of NodeProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Node profile assigned to the physical router during device discovery/onboarding.

  • list of DeviceFunctionalGroup objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Device functional group that this physical-router belongs to.

  • list of DeviceChassis objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Device Chassis info assigned to the physical router during device discovery/onboarding.

  • list of DeviceImage objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Intended device image for this PRouter. Each PRouter can have one and only one device image

    assigned. If this image is successfully installed on the PRouter, the PRouterUVE.os_version should

    match the os-version property of the image

  • list of PhysicalRole objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Physical role assigned to this physical router

  • list of OverlayRole objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Overlay roles assigned to this physical router

  • list of TelemetryProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Telemetry profile assigned to the physical router by user. Each physical router is associated with

    only one telemetry profile.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_bgp_router(ref_obj)

Add bgp-router to physical-router.

Parameters:ref_obj – BgpRouter object
add_device_chassis(ref_obj)

Add device-chassis to physical-router.

Parameters:ref_obj – DeviceChassis object
add_device_functional_group(ref_obj)

Add device-functional-group to physical-router.

Parameters:ref_obj – DeviceFunctionalGroup object
add_device_image(ref_obj)

Add device-image to physical-router.

Parameters:ref_obj – DeviceImage object
add_fabric(ref_obj)

Add fabric to physical-router.

Parameters:ref_obj – Fabric object
add_intent_map(ref_obj)

Add intent-map to physical-router.

Parameters:ref_obj – IntentMap object
add_node_profile(ref_obj)

Add node-profile to physical-router.

Parameters:ref_obj – NodeProfile object
add_overlay_role(ref_obj)

Add overlay-role to physical-router.

Parameters:ref_obj – OverlayRole object
add_physical_role(ref_obj)

Add physical-role to physical-router.

Parameters:ref_obj – PhysicalRole object
add_tag(ref_obj)

Add tag to physical-router.

Parameters:ref_obj – Tag object
add_telemetry_profile(ref_obj)

Add telemetry-profile to physical-router.

Parameters:ref_obj – TelemetryProfile 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
annotations

Get annotations for physical-router.

Returns:KeyValuePairs 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_device_chassis_refs()

Return device-chassis list for physical-router.

Returns:list of <DeviceChassis>
get_device_functional_group_refs()

Return device-functional-group list for physical-router.

Returns:list of <DeviceFunctionalGroup>
get_device_image_refs()

Return device-image list for physical-router.

Returns:list of <DeviceImage>
get_e2_service_provider_back_refs()

Return list of all e2-service-providers using this physical-router

get_fabric_refs()

Return fabric list for physical-router.

Returns:list of <Fabric>
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_intent_map_refs()

Return intent-map list for physical-router.

Returns:list of <IntentMap>
get_logical_router_back_refs()

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

get_network_device_config_back_refs()

Return list of all network-device-configs using this physical-router

get_node_profile_refs()

Return node-profile list for physical-router.

Returns:list of <NodeProfile>
get_overlay_role_refs()

Return overlay-role list for physical-router.

Returns:list of <OverlayRole>
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_physical_role_refs()

Return physical-role list for physical-router.

Returns:list of <PhysicalRole>
get_service_endpoint_back_refs()

Return list of all service-endpoints using this physical-router

get_tag_refs()

Return tag list for physical-router.

Returns:list of <Tag>
get_telemetry_profile_refs()

Return telemetry-profile list for physical-router.

Returns:list of <TelemetryProfile>
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_autonomous_system

Get physical-router-autonomous-system for physical-router.

Returns:AutonomousSystemsType object
physical_router_cli_commit_state

Get physical-router-cli-commit-state for physical-router.

Returns:CommitStateType object
physical_router_dataplane_ip

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

Returns:IpAddress object
physical_router_device_family

Get physical-router-device-family for physical-router.

Returns:xsd:string object
physical_router_dhcp_parameters

Get physical-router-dhcp-parameters for physical-router.

Returns:DnsmasqLeaseParameters object
physical_router_encryption_type

Get physical-router-encryption-type for physical-router.

Returns:CredentialEncryptionType object
physical_router_hostname

Get physical-router-hostname for physical-router.

Returns:xsd:string object
physical_router_junos_service_ports

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

Returns:JunosServicePorts object
physical_router_lldp

Get physical-router-lldp for physical-router.

Returns:xsd:boolean object
physical_router_loopback_ip

Get physical-router-loopback-ip for physical-router.

Returns:IpAddress object
physical_router_managed_state

Get physical-router-managed-state for physical-router.

Returns:ManagedStateType object
physical_router_management_ip

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

Returns:IpAddress object
physical_router_management_mac

Get physical-router-management-mac for physical-router.

Returns:xsd:string object
physical_router_onboarding_state

Get physical-router-onboarding-state for physical-router.

Returns:OnboardingStateType object
physical_router_os_version

Get physical-router-os-version for physical-router.

Returns:xsd:string object
physical_router_product_name

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

Returns:xsd:string object
physical_router_replicator_loopback_ip

Get physical-router-replicator-loopback-ip for physical-router.

Returns:IpAddress object
physical_router_role

Get physical-router-role for physical-router.

Returns:PhysicalRouterRole object
physical_router_serial_number

Get physical-router-serial-number for physical-router.

Returns:xsd:string object
physical_router_snmp

Get physical-router-snmp for physical-router.

Returns:xsd:boolean object
physical_router_snmp_credentials

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

Returns:SNMPCredentials object
physical_router_supplemental_config

Get physical-router-supplemental-config for physical-router.

Returns:xsd:string object
physical_router_underlay_config

Get physical-router-underlay-config for physical-router.

Returns:xsd:string object
physical_router_underlay_managed

Get physical-router-underlay-managed for physical-router.

Returns:xsd:boolean 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
routing_bridging_roles

Get routing-bridging-roles for physical-router.

Returns:RoutingBridgingRolesType 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_device_chassis(ref_obj)

Set device-chassis for physical-router.

Parameters:ref_obj – DeviceChassis object
set_device_chassis_list(ref_obj_list)

Set device-chassis list for physical-router.

Parameters:ref_obj_list – list of DeviceChassis object
set_device_functional_group(ref_obj)

Set device-functional-group for physical-router.

Parameters:ref_obj – DeviceFunctionalGroup object
set_device_functional_group_list(ref_obj_list)

Set device-functional-group list for physical-router.

Parameters:ref_obj_list – list of DeviceFunctionalGroup object
set_device_image(ref_obj)

Set device-image for physical-router.

Parameters:ref_obj – DeviceImage object
set_device_image_list(ref_obj_list)

Set device-image list for physical-router.

Parameters:ref_obj_list – list of DeviceImage object
set_fabric(ref_obj)

Set fabric for physical-router.

Parameters:ref_obj – Fabric object
set_fabric_list(ref_obj_list)

Set fabric list for physical-router.

Parameters:ref_obj_list – list of Fabric object
set_intent_map(ref_obj)

Set intent-map for physical-router.

Parameters:ref_obj – IntentMap object
set_intent_map_list(ref_obj_list)

Set intent-map list for physical-router.

Parameters:ref_obj_list – list of IntentMap object
set_node_profile(ref_obj)

Set node-profile for physical-router.

Parameters:ref_obj – NodeProfile object
set_node_profile_list(ref_obj_list)

Set node-profile list for physical-router.

Parameters:ref_obj_list – list of NodeProfile object
set_overlay_role(ref_obj)

Set overlay-role for physical-router.

Parameters:ref_obj – OverlayRole object
set_overlay_role_list(ref_obj_list)

Set overlay-role list for physical-router.

Parameters:ref_obj_list – list of OverlayRole object
set_physical_role(ref_obj)

Set physical-role for physical-router.

Parameters:ref_obj – PhysicalRole object
set_physical_role_list(ref_obj_list)

Set physical-role list for physical-router.

Parameters:ref_obj_list – list of PhysicalRole object
set_tag(ref_obj)

Set tag for physical-router.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for physical-router.

Parameters:ref_obj_list – list of Tag object
set_telemetry_profile(ref_obj)

Set telemetry-profile for physical-router.

Parameters:ref_obj – TelemetryProfile object
set_telemetry_profile_list(ref_obj_list)

Set telemetry-profile list for physical-router.

Parameters:ref_obj_list – list of TelemetryProfile 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
telemetry_info

Get telemetry-info for physical-router.

Returns:TelemetryStateInfo object
class gen.resource_common.PolicyManagement(name=None, parent_obj=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

When parent is config-root:
Global level policy-management object re-grouping global policy resources.
When parent is project:
Project level policy-management object re-grouping project policy resources
Created By:
User when parent is ConfigRoot User when parent is Project
Child of:
ConfigRoot object OR Project object
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 ServiceGroup objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Service Group object

  • list of AddressGroup objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Address Group object

  • list of FirewallRule objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Firewall-rule object

  • list of FirewallPolicy objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    firewall-policy object consisting of one or more firewall rules

  • list of ApplicationPolicySet objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Application-policy object defining policies to apply for a given application tag

References to:
  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to policy-management.

Parameters:ref_obj – Tag object
annotations

Get annotations for policy-management.

Returns:KeyValuePairs object
display_name

Get display-name for policy-management.

Returns:xsd:string object
dump()

Display policy-management object in compact form.

get_fq_name()

Return FQN of policy-management in list form.

get_fq_name_str()

Return FQN of policy-management as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for policy-management.

Returns:list of <Tag>
get_type()

Return object type (policy-management).

id_perms

Get id-perms for policy-management.

Returns:IdPermsType object
perms2

Get perms2 for policy-management.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for policy-management.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for policy-management.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.Port(name=None, parent_obj=None, port_group_uuid=None, bms_port_info=None, esxi_port_info=None, label=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Parent of this port.

Created By:
User
Child of:
Node object
Properties:
  • port_group_uuid

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    UUID of the port group in which this port belongs

  • bms_port_info

    Type: BaremetalPortInfo

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Details of the baremetal server port

  • esxi_port_info

    Type: ESXIProperties

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Information related to Port-ESXi/vCenter

  • label

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Label of the interface representing the use of the interface.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to port.

Parameters:ref_obj – Tag object
annotations

Get annotations for port.

Returns:KeyValuePairs object
bms_port_info

Get bms-port-info for port.

Returns:BaremetalPortInfo object
display_name

Get display-name for port.

Returns:xsd:string object
dump()

Display port object in compact form.

esxi_port_info

Get esxi-port-info for port.

Returns:ESXIProperties object
get_fq_name()

Return FQN of port in list form.

get_fq_name_str()

Return FQN of port as colon delimited string.

get_parent_fq_name()

Return FQN of port’s parent in list form.

get_parent_fq_name_str()

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

get_physical_interface_back_refs()

Return list of all physical-interfaces using this port

get_port_group_back_refs()

Return list of all port-groups using this port

get_tag_refs()

Return tag list for port.

Returns:list of <Tag>
get_type()

Return object type (port).

id_perms

Get id-perms for port.

Returns:IdPermsType object
label

Get label for port.

Returns:xsd:string object
perms2

Get perms2 for port.

Returns:PermType2 object
port_group_uuid

Get port-group-uuid for port.

Returns:xsd:string object
set_tag(ref_obj)

Set tag for port.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for port.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.PortGroup(name=None, parent_obj=None, bms_port_group_info=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Parent of this port group.

Created By:
User
Child of:
Node object
Properties:
  • bms_port_group_info

    Type: BaremetalPortGroupInfo

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Details of the baremetal server port group

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Port objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to port object which are part of this port group.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_port(ref_obj)

Add port to port-group.

Parameters:ref_obj – Port object
add_tag(ref_obj)

Add tag to port-group.

Parameters:ref_obj – Tag object
annotations

Get annotations for port-group.

Returns:KeyValuePairs object
bms_port_group_info

Get bms-port-group-info for port-group.

Returns:BaremetalPortGroupInfo object
display_name

Get display-name for port-group.

Returns:xsd:string object
dump()

Display port-group object in compact form.

get_fq_name()

Return FQN of port-group in list form.

get_fq_name_str()

Return FQN of port-group as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_port_refs()

Return port list for port-group.

Returns:list of <Port>
get_tag_refs()

Return tag list for port-group.

Returns:list of <Tag>
get_type()

Return object type (port-group).

id_perms

Get id-perms for port-group.

Returns:IdPermsType object
perms2

Get perms2 for port-group.

Returns:PermType2 object
set_port(ref_obj)

Set port for port-group.

Parameters:ref_obj – Port object
set_port_list(ref_obj_list)

Set port list for port-group.

Parameters:ref_obj_list – list of Port object
set_tag(ref_obj)

Set tag for port-group.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for port-group.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.PortProfile(name=None, parent_obj=None, port_profile_params=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Encapsulates port configurations like storm control, QoS etc

Created By:
User
Child of:
Project object
Properties:
  • port_profile_params

    Type: PortProfileParameters

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This is to configure port attributes.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 StormControlProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Storm control profile that this port profile uses.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_storm_control_profile(ref_obj)

Add storm-control-profile to port-profile.

Parameters:ref_obj – StormControlProfile object
add_tag(ref_obj)

Add tag to port-profile.

Parameters:ref_obj – Tag object
annotations

Get annotations for port-profile.

Returns:KeyValuePairs object
display_name

Get display-name for port-profile.

Returns:xsd:string object
dump()

Display port-profile object in compact form.

get_fq_name()

Return FQN of port-profile in list form.

get_fq_name_str()

Return FQN of port-profile as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_storm_control_profile_refs()

Return storm-control-profile list for port-profile.

Returns:list of <StormControlProfile>
get_tag_refs()

Return tag list for port-profile.

Returns:list of <Tag>
get_type()

Return object type (port-profile).

get_virtual_machine_interface_back_refs()

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

get_virtual_port_group_back_refs()

Return list of all virtual-port-groups using this port-profile

id_perms

Get id-perms for port-profile.

Returns:IdPermsType object
perms2

Get perms2 for port-profile.

Returns:PermType2 object
port_profile_params

Get port-profile-params for port-profile.

Returns:PortProfileParameters object
set_storm_control_profile(ref_obj)

Set storm-control-profile for port-profile.

Parameters:ref_obj – StormControlProfile object
set_storm_control_profile_list(ref_obj_list)

Set storm-control-profile list for port-profile.

Parameters:ref_obj_list – list of StormControlProfile object
set_tag(ref_obj)

Set tag for port-profile.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for port-profile.

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

Bases: future.types.newobject.newobject

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)].

Created By:
User
Child of:
ServiceInstance object
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 LogicalRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of tenant logical routers to be attached to the service left or right attachment point

  • list of VirtualNetwork objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Internal virtual networks for PNF left or right service attachment points are used to internally to

    allocate route targets for the left and right service VRFs on the spine device

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_logical_router(ref_obj)

Add logical-router to port-tuple.

Parameters:ref_obj – LogicalRouter object
add_tag(ref_obj)

Add tag to port-tuple.

Parameters:ref_obj – Tag object
add_virtual_network(ref_obj)

Add virtual-network to port-tuple.

Parameters:ref_obj – VirtualNetwork object
annotations

Get annotations for port-tuple.

Returns:KeyValuePairs object
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_logical_router_refs()

Return logical-router list for port-tuple.

Returns:list of <LogicalRouter>
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_tag_refs()

Return tag list for port-tuple.

Returns:list of <Tag>
get_type()

Return object type (port-tuple).

get_virtual_machine_interface_back_refs()

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

get_virtual_network_refs()

Return virtual-network list for port-tuple.

Returns:list of <VirtualNetwork>
id_perms

Get id-perms for port-tuple.

Returns:IdPermsType object
perms2

Get perms2 for port-tuple.

Returns:PermType2 object
set_logical_router(ref_obj)

Set logical-router for port-tuple.

Parameters:ref_obj – LogicalRouter object
set_logical_router_list(ref_obj_list)

Set logical-router list for port-tuple.

Parameters:ref_obj_list – list of LogicalRouter object
set_tag(ref_obj)

Set tag for port-tuple.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for port-tuple.

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

Set virtual-network for port-tuple.

Parameters:ref_obj – VirtualNetwork object
set_virtual_network_list(ref_obj_list)

Set virtual-network list for port-tuple.

Parameters:ref_obj_list – list of VirtualNetwork object
class gen.resource_common.Project(name=None, parent_obj=None, quota=None, vxlan_routing=None, alarm_enable=None, enable_security_policy_draft=False, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Project represent one instance of application or tenant.

Created By:
System
Child of:
Domain object
Properties:
  • quota

    Type: QuotaType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Max instances limits for various objects under project.

  • vxlan_routing

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    When this knob is enabled for a project, an internal system VN (VN-Int) is created for every logical

    router in the 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.

  • enable_security_policy_draft

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 SecurityLoggingObject objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Security logging object configuration for specifying session logging criteria

  • 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 queuing 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 mechanism 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 mechanism of adding static routes in the virtual network

  • list of InterfaceRouteTable objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

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

  • list of LogicalRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Logical router is a mechanism 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 MulticastPolicy objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

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

  • list of LoadbalancerPool objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Loadbalancer pool object represent set(pool) member 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 object 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 Bgpvpn objects

    Created By: User (optional)

    Operations Allowed: CR

    Description:

    BGP VPN resource contains a set of parameters for a BGP-based VPN

  • list of Alarm objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

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

  • list of PolicyManagement objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Project level policy-management object re-grouping project policy resources

  • list of ServiceGroup objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Project level service Group object

  • list of AddressGroup objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Project level address Group object

  • list of FirewallRule objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Project level firewall-rule object

  • list of FirewallPolicy objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Project level firewall-policy object consisting of one or more firewall rules

  • list of ApplicationPolicySet objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Project level application-policy object defining policies to apply for a given application tag

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Attribute attached to objects - has a type and value

  • list of DeviceFunctionalGroup objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of device functional groups in this project.

  • list of VirtualPortGroup objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of virtual port groups/trunk ports in this project.

  • list of TelemetryProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of telemetry profiles supported under the project.

  • list of SflowProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of sflow profiles supported under the project.

  • list of GrpcProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of grpc profiles supported under the project.

  • list of SnmpProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of snmp profiles supported under the project.

  • list of NetconfProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of netconf profiles supported under the project.

  • list of StormControlProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of storm control profiles supported.

  • list of PortProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Encapsulates port configurations like storm control etc

  • list of HostBasedService objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Project level host based service.

  • list of StructuredSyslogConfig objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of structured-syslog-config that are applicable to objects anchored under 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:

    Deprecated as it is not needed. Will be removed in future.

  • list of AliasIpPool objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to alias ip pool in this project.

  • list of ApplicationPolicySet objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Reference to default application-policy-set is automatically created by system for default socped

    application policy sets. Needed by vrouter to identify default application-policy-set rules of a

    virtual machine interface

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_alias_ip_pool(ref_obj)

Add alias-ip-pool to project.

Parameters:ref_obj – AliasIpPool object
add_application_policy_set(ref_obj)

Add application-policy-set to project.

Parameters:ref_obj – ApplicationPolicySet object
add_floating_ip_pool(ref_obj)

Add floating-ip-pool to project.

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

Add namespace to project.

Parameters:
  • ref_obj – Namespace object
  • ref_data – SubnetType object
add_tag(ref_obj)

Add tag to project.

Parameters:ref_obj – Tag object
alarm_enable

Get alarm-enable for project.

Returns:xsd:boolean object
annotations

Get annotations for project.

Returns:KeyValuePairs object
display_name

Get display-name for project.

Returns:xsd:string object
dump()

Display project object in compact form.

enable_security_policy_draft

Get enable-security-policy-draft for project.

Returns:xsd:boolean object
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_application_policy_set_refs()

Return application-policy-set list for project.

Returns:list of <ApplicationPolicySet>
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_tag_refs()

Return tag list for project.

Returns:list of <Tag>
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_application_policy_set(ref_obj)

Set application-policy-set for project.

Parameters:ref_obj – ApplicationPolicySet object
set_application_policy_set_list(ref_obj_list)

Set application-policy-set list for project.

Parameters:ref_obj_list – list of ApplicationPolicySet 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=None)

Set namespace for project.

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

Set namespace list for project.

Parameters:
  • ref_obj_list – list of Namespace object
  • ref_data_list – list of SubnetType object
set_tag(ref_obj)

Set tag for project.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for project.

Parameters:ref_obj_list – list of Tag object
vxlan_routing

Get vxlan-routing for project.

Returns:xsd:boolean object
class gen.resource_common.ProviderAttachment(name=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to provider-attachment.

Parameters:ref_obj – Tag object
add_virtual_router(ref_obj)

Add virtual-router to provider-attachment.

Parameters:ref_obj – VirtualRouter object
annotations

Get annotations for provider-attachment.

Returns:KeyValuePairs 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_tag_refs()

Return tag list for provider-attachment.

Returns:list of <Tag>
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_tag(ref_obj)

Set tag for provider-attachment.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for provider-attachment.

Parameters:ref_obj_list – list of Tag 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 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=0, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

When parent is global-qos-config:
Global system QoS config for vhost and fabric traffic .

When parent is project:

Created By:
User when parent is GlobalQosConfig User when parent is Project
Child of:
GlobalQosConfig object OR Project object
Properties:
  • qos_config_type

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

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Specifies if qos-config is for vhost, fabric or for project.

  • dscp_entries

    Type: QosIdForwardingClassPairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Map of DSCP match condition and applicable forwarding class for packet.

  • vlan_priority_entries

    Type: QosIdForwardingClassPairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Map of .1p priority code to applicable forwarding class for packet.

  • mpls_exp_entries

    Type: QosIdForwardingClassPairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Map of MPLS EXP values to applicable forwarding class for packet.

  • default_forwarding_class_id

    Type: int, within [0, 255]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Default forwarding class used for all non-specified QOS bits

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 GlobalSystemConfig objects

    Created By: System

    Operations Allowed: CR

    Description:

    This link is internally created and may be removed in future. End users should not set this link or

    assume it to be there

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_global_system_config(ref_obj)

Add global-system-config to qos-config.

Parameters:ref_obj – GlobalSystemConfig object
add_tag(ref_obj)

Add tag to qos-config.

Parameters:ref_obj – Tag object
annotations

Get annotations for qos-config.

Returns:KeyValuePairs object
default_forwarding_class_id

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

Returns:ForwardingClassId 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_global_system_config_refs()

Return global-system-config list for qos-config.

Returns:list of <GlobalSystemConfig>
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_tag_refs()

Return tag list for qos-config.

Returns:list of <Tag>
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
set_global_system_config(ref_obj)

Set global-system-config for qos-config.

Parameters:ref_obj – GlobalSystemConfig object
set_global_system_config_list(ref_obj_list)

Set global-system-config list for qos-config.

Parameters:ref_obj_list – list of GlobalSystemConfig object
set_tag(ref_obj)

Set tag for qos-config.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for qos-config.

Parameters:ref_obj_list – list of Tag object
vlan_priority_entries

Get vlan-priority-entries for qos-config.

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

Bases: future.types.newobject.newobject

QOS queue config object in this project.

Created By:
User
Child of:
GlobalQosConfig object
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.

  • qos_queue_identifier

    Type: int

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Unique id for this queue.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to qos-queue.

Parameters:ref_obj – Tag object
annotations

Get annotations for qos-queue.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for qos-queue.

Returns:list of <Tag>
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
qos_queue_identifier

Get qos-queue-identifier for qos-queue.

Returns:xsd:integer object
set_tag(ref_obj)

Set tag for qos-queue.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for qos-queue.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.RoleConfig(name=None, parent_obj=None, role_config_config=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

This resource exposes to users additional parameters to configure a specify physical or routing/switching roles. These are the config parameters that are mot modeled in VNC data model and we don’t want to hard code in the fabric ansible playbooks. These could be vendor specific parameters or could be extended by the field or customer who might want to tweak the playbooks. The schema for the role config are defined in the job-template.input_schema. This schema could be used by the UI to generically render the form for user to edit the config.

Created By:
User
Child of:
NodeProfile object
Properties:
  • role_config_config

    Type: str

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    role config in JSON format. This JSON config must conform to the input-schema of the job template

    for the role provisioning.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to role-config.

Parameters:ref_obj – Tag object
annotations

Get annotations for role-config.

Returns:KeyValuePairs object
display_name

Get display-name for role-config.

Returns:xsd:string object
dump()

Display role-config object in compact form.

get_fq_name()

Return FQN of role-config in list form.

get_fq_name_str()

Return FQN of role-config as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for role-config.

Returns:list of <Tag>
get_type()

Return object type (role-config).

id_perms

Get id-perms for role-config.

Returns:IdPermsType object
perms2

Get perms2 for role-config.

Returns:PermType2 object
role_config_config

Get role-config-config for role-config.

Returns:xsd:string object
set_tag(ref_obj)

Set tag for role-config.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for role-config.

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

Bases: future.types.newobject.newobject

Defines a role combination which comprises of a physical role and overlay role and the features associated with it.

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 FeatureConfig objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of feature configs for this role definition.

References to:
  • list of Feature objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of features for this role definition.

  • list of PhysicalRole objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    physical role for this role definition.

  • list of OverlayRole objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    overlay role for this role definition.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_feature(ref_obj)

Add feature to role-definition.

Parameters:ref_obj – Feature object
add_overlay_role(ref_obj)

Add overlay-role to role-definition.

Parameters:ref_obj – OverlayRole object
add_physical_role(ref_obj)

Add physical-role to role-definition.

Parameters:ref_obj – PhysicalRole object
add_tag(ref_obj)

Add tag to role-definition.

Parameters:ref_obj – Tag object
annotations

Get annotations for role-definition.

Returns:KeyValuePairs object
display_name

Get display-name for role-definition.

Returns:xsd:string object
dump()

Display role-definition object in compact form.

get_feature_refs()

Return feature list for role-definition.

Returns:list of <Feature>
get_fq_name()

Return FQN of role-definition in list form.

get_fq_name_str()

Return FQN of role-definition as colon delimited string.

get_node_profile_back_refs()

Return list of all node-profiles using this role-definition

get_overlay_role_refs()

Return overlay-role list for role-definition.

Returns:list of <OverlayRole>
get_parent_fq_name()

Return FQN of role-definition’s parent in list form.

get_parent_fq_name_str()

Return FQN of role-definition’s parent as colon delimted string.

get_physical_role_refs()

Return physical-role list for role-definition.

Returns:list of <PhysicalRole>
get_tag_refs()

Return tag list for role-definition.

Returns:list of <Tag>
get_type()

Return object type (role-definition).

id_perms

Get id-perms for role-definition.

Returns:IdPermsType object
perms2

Get perms2 for role-definition.

Returns:PermType2 object
set_feature(ref_obj)

Set feature for role-definition.

Parameters:ref_obj – Feature object
set_feature_list(ref_obj_list)

Set feature list for role-definition.

Parameters:ref_obj_list – list of Feature object
set_overlay_role(ref_obj)

Set overlay-role for role-definition.

Parameters:ref_obj – OverlayRole object
set_overlay_role_list(ref_obj_list)

Set overlay-role list for role-definition.

Parameters:ref_obj_list – list of OverlayRole object
set_physical_role(ref_obj)

Set physical-role for role-definition.

Parameters:ref_obj – PhysicalRole object
set_physical_role_list(ref_obj_list)

Set physical-role list for role-definition.

Parameters:ref_obj_list – list of PhysicalRole object
set_tag(ref_obj)

Set tag for role-definition.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for role-definition.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.RouteAggregate(name=None, parent_obj=None, aggregate_route_entries=None, aggregate_route_nexthop=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
Project object
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: str

    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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

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=None)

Add service-instance to route-aggregate.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – ServiceInterfaceTag object
add_tag(ref_obj)

Add tag to route-aggregate.

Parameters:ref_obj – Tag 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
annotations

Get annotations for route-aggregate.

Returns:KeyValuePairs 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_tag_refs()

Return tag list for route-aggregate.

Returns:list of <Tag>
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=None)

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=None)

Set service-instance list for route-aggregate.

Parameters:
  • ref_obj_list – list of ServiceInstance object
  • ref_data_list – list of ServiceInterfaceTag object
set_tag(ref_obj)

Set tag for route-aggregate.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for route-aggregate.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.RouteTable(name=None, parent_obj=None, routes=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
Project object
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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to route-table.

Parameters:ref_obj – Tag object
annotations

Get annotations for route-table.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for route-table.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for route-table.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for route-table.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.RouteTarget(name=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to route-target.

Parameters:ref_obj – Tag object
annotations

Get annotations for route-target.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for route-target.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for route-target.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for route-target.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.RoutingInstance(name=None, parent_obj=None, service_chain_information=None, ipv6_service_chain_information=None, evpn_service_chain_information=None, evpn_ipv6_service_chain_information=None, routing_instance_is_default=False, routing_instance_has_pnf=False, static_route_entries=None, routing_instance_fabric_snat=False, default_ce_protocol=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
System
Child of:
VirtualNetwork object
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.

  • evpn_service_chain_information

    Type: ServiceChainInfo

    Created By: System

    Operations Allowed: CRUD

    Description:

    Internal service chaining information, should not be modified.

  • evpn_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.

  • routing_instance_fabric_snat

    Type: bool

    Created By: System

    Operations Allowed: CRUD

    Description:

    Provide connectivity to underlay network by port mapping trafficwith source IP of compute node

  • default_ce_protocol

    Type: DefaultProtocolType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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:
  • list of (RoutingInstance object, ConnectionType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • list of (RouteTarget object, InstanceTargetType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_route_target(ref_obj, ref_data=None)

Add route-target to routing-instance.

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

Add routing-instance to routing-instance.

Parameters:
  • ref_obj – RoutingInstance object
  • ref_data – ConnectionType object
add_tag(ref_obj)

Add tag to routing-instance.

Parameters:ref_obj – Tag object
annotations

Get annotations for routing-instance.

Returns:KeyValuePairs 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.

evpn_ipv6_service_chain_information

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

Returns:ServiceChainInfo object
evpn_service_chain_information

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

Returns:ServiceChainInfo object
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_tag_refs()

Return tag list for routing-instance.

Returns:list of <Tag>
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_fabric_snat

Get routing-instance-fabric-snat for routing-instance.

Returns:xsd:boolean 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=None)

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=None)

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=None)

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=None)

Set routing-instance list for routing-instance.

Parameters:
  • ref_obj_list – list of RoutingInstance object
  • ref_data_list – list of ConnectionType object
set_tag(ref_obj)

Set tag for routing-instance.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for routing-instance.

Parameters:ref_obj_list – list of Tag object
static_route_entries

Get static-route-entries for routing-instance.

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

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
Project object
Properties:
  • routing_policy_entries

    Type: PolicyStatementType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • term_type

    Type: str, one-of [u’vrouter’, u’network-device’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 InterfaceRouteTable objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to interface route table attached to routing policy.

  • 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:

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_interface_route_table(ref_obj)

Add interface-route-table to routing-policy.

Parameters:ref_obj – InterfaceRouteTable object
add_routing_instance(ref_obj, ref_data=None)

Add routing-instance to routing-policy.

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

Add service-instance to routing-policy.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – RoutingPolicyServiceInstanceType object
add_tag(ref_obj)

Add tag to routing-policy.

Parameters:ref_obj – Tag object
annotations

Get annotations for routing-policy.

Returns:KeyValuePairs object
display_name

Get display-name for routing-policy.

Returns:xsd:string object
dump()

Display routing-policy object in compact form.

get_data_center_interconnect_back_refs()

Return list of all data-center-interconnects using this routing-policy

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_interface_route_table_refs()

Return interface-route-table list for routing-policy.

Returns:list of <InterfaceRouteTable>
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_tag_refs()

Return tag list for routing-policy.

Returns:list of <Tag>
get_type()

Return object type (routing-policy).

get_virtual_network_back_refs()

Return list of all virtual-networks using this 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_interface_route_table(ref_obj)

Set interface-route-table for routing-policy.

Parameters:ref_obj – InterfaceRouteTable object
set_interface_route_table_list(ref_obj_list)

Set interface-route-table list for routing-policy.

Parameters:ref_obj_list – list of InterfaceRouteTable object
set_routing_instance(ref_obj, ref_data=None)

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=None)

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=None)

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=None)

Set service-instance list for routing-policy.

Parameters:
  • ref_obj_list – list of ServiceInstance object
  • ref_data_list – list of RoutingPolicyServiceInstanceType object
set_tag(ref_obj)

Set tag for routing-policy.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for routing-policy.

Parameters:ref_obj_list – list of Tag object
term_type

Get term-type for routing-policy.

Returns:TermType object
class gen.resource_common.SecurityGroup(name=None, parent_obj=None, security_group_id=None, configured_security_group_id=0, security_group_entries=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
Project object
Properties:
  • security_group_id

    Type: int, within [8000000, 4294967296]

    Created By: System

    Operations Allowed: R

    Description:

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

  • configured_security_group_id

    Type: int, within [0, 7999999]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Unique 32 bit user defined ID assigned to this security group [1, 8M - 1].

  • 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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 automatically derived from all the security groups attached to port.

References to:
  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to security-group.

Parameters:ref_obj – Tag object
annotations

Get annotations for security-group.

Returns:KeyValuePairs object
configured_security_group_id

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

Returns:ConfiguredSecurityGroupIdType 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_security_logging_object_back_refs()

Return list of all security-logging-objects using this security-group

get_tag_refs()

Return tag list for security-group.

Returns:list of <Tag>
get_type()

Return object type (security-group).

get_virtual_machine_interface_back_refs()

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

get_virtual_port_group_back_refs()

Return list of all virtual-port-groups 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:SecurityGroupIdType object
set_tag(ref_obj)

Set tag for security-group.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for security-group.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.SecurityLoggingObject(name=None, parent_obj=None, security_logging_object_rules=None, security_logging_object_rate=100, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

When parent is global-vrouter-config:
Reference to security logging object for global-vrouter-config.
When parent is project:
Security logging object configuration for specifying session logging criteria
Created By:
User when parent is GlobalVrouterConfig User when parent is Project
Child of:
GlobalVrouterConfig object OR Project object
Properties:
  • security_logging_object_rules

    Type: SecurityLoggingObjectRuleListType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Security logging object rules derived internally.

  • security_logging_object_rate

    Type: int

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Security logging object rate defining rate of session logging

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 (NetworkPolicy object, SecurityLoggingObjectRuleListType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to network-policy attached to this security-logging-object

  • list of (SecurityGroup object, SecurityLoggingObjectRuleListType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to security-group attached to this security-logging-object

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_network_policy(ref_obj, ref_data=None)

Add network-policy to security-logging-object.

Parameters:
  • ref_obj – NetworkPolicy object
  • ref_data – SecurityLoggingObjectRuleListType object
add_security_group(ref_obj, ref_data=None)

Add security-group to security-logging-object.

Parameters:
  • ref_obj – SecurityGroup object
  • ref_data – SecurityLoggingObjectRuleListType object
add_tag(ref_obj)

Add tag to security-logging-object.

Parameters:ref_obj – Tag object
annotations

Get annotations for security-logging-object.

Returns:KeyValuePairs object
display_name

Get display-name for security-logging-object.

Returns:xsd:string object
dump()

Display security-logging-object object in compact form.

get_firewall_policy_back_refs()

Return list of all firewall-policys using this security-logging-object

get_firewall_rule_back_refs()

Return list of all firewall-rules using this security-logging-object

get_fq_name()

Return FQN of security-logging-object in list form.

get_fq_name_str()

Return FQN of security-logging-object as colon delimited string.

get_network_policy_refs()

Return network-policy list for security-logging-object.

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

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

get_parent_fq_name_str()

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

get_security_group_refs()

Return security-group list for security-logging-object.

Returns:list of tuple <SecurityGroup, SecurityLoggingObjectRuleListType>
get_tag_refs()

Return tag list for security-logging-object.

Returns:list of <Tag>
get_type()

Return object type (security-logging-object).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this security-logging-object

get_virtual_network_back_refs()

Return list of all virtual-networks using this security-logging-object

id_perms

Get id-perms for security-logging-object.

Returns:IdPermsType object
perms2

Get perms2 for security-logging-object.

Returns:PermType2 object
security_logging_object_rate

Get security-logging-object-rate for security-logging-object.

Returns:xsd:integer object
security_logging_object_rules

Get security-logging-object-rules for security-logging-object.

Returns:SecurityLoggingObjectRuleListType object
set_network_policy(ref_obj, ref_data=None)

Set network-policy for security-logging-object.

Parameters:
  • ref_obj – NetworkPolicy object
  • ref_data – SecurityLoggingObjectRuleListType object
set_network_policy_list(ref_obj_list, ref_data_list=None)

Set network-policy list for security-logging-object.

Parameters:
  • ref_obj_list – list of NetworkPolicy object
  • ref_data_list – list of SecurityLoggingObjectRuleListType object
set_security_group(ref_obj, ref_data=None)

Set security-group for security-logging-object.

Parameters:
  • ref_obj – SecurityGroup object
  • ref_data – SecurityLoggingObjectRuleListType object
set_security_group_list(ref_obj_list, ref_data_list=None)

Set security-group list for security-logging-object.

Parameters:
  • ref_obj_list – list of SecurityGroup object
  • ref_data_list – list of SecurityLoggingObjectRuleListType object
set_tag(ref_obj)

Set tag for security-logging-object.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for security-logging-object.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.ServiceAppliance(name=None, parent_obj=None, service_appliance_user_credentials=None, service_appliance_ip_address=None, service_appliance_virtualization_type=None, service_appliance_properties=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Service appliance is a member in service appliance set (e.g. Loadbalancer, Firewall provider).By default system will create “ha-proxy” based service appliance.

Created By:
User
Child of:
ServiceApplianceSet object
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: str, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Management Ip address of the service-appliance.

  • service_appliance_virtualization_type

    Type: str, one-of [u’virtual-machine’, u’network-namespace’, u’vrouter-instance’, u’physical-device’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Service virtualization type decides how individual service instances are instantiated

  • 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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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, management

    OR other.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_physical_interface(ref_obj, ref_data=None)

Add physical-interface to service-appliance.

Parameters:
  • ref_obj – PhysicalInterface object
  • ref_data – ServiceApplianceInterfaceType object
add_tag(ref_obj)

Add tag to service-appliance.

Parameters:ref_obj – Tag object
annotations

Get annotations for service-appliance.

Returns:KeyValuePairs 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_tag_refs()

Return tag list for service-appliance.

Returns:list of <Tag>
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
service_appliance_virtualization_type

Get service-appliance-virtualization-type for service-appliance.

Returns:ServiceVirtualizationType object
set_physical_interface(ref_obj, ref_data=None)

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=None)

Set physical-interface list for service-appliance.

Parameters:
  • ref_obj_list – list of PhysicalInterface object
  • ref_data_list – list of ServiceApplianceInterfaceType object
set_tag(ref_obj)

Set tag for service-appliance.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for service-appliance.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.ServiceApplianceSet(name=None, parent_obj=None, service_appliance_set_virtualization_type=None, service_appliance_set_properties=None, service_appliance_driver=None, service_appliance_ha_mode=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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.
Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • service_appliance_set_virtualization_type

    Type: str, one-of [u’virtual-machine’, u’network-namespace’, u’vrouter-instance’, u’physical-device’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Service virtualization type decides how individual service instances are instantiated

  • 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: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Name of the provider driver for this service appliance set.

  • service_appliance_ha_mode

    Type: str

    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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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:
  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to service-appliance-set.

Parameters:ref_obj – Tag object
annotations

Get annotations for service-appliance-set.

Returns:KeyValuePairs object
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_back_refs()

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

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_tag_refs()

Return tag list for service-appliance-set.

Returns:list of <Tag>
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
service_appliance_set_virtualization_type

Get service-appliance-set-virtualization-type for service-appliance-set.

Returns:ServiceVirtualizationType object
set_tag(ref_obj)

Set tag for service-appliance-set.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for service-appliance-set.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.ServiceConnectionModule(name=None, e2_service=None, service_type=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

Properties:
  • e2_service

    Type: str, one-of [u’point-to-point’, u’point-to-list’, u’multi-point-to-multi-point’]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    E2 service type.

  • service_type

    Type: str, one-of [u’vpws-l2ckt’, u’vpws-l2vpn’, u’vpws-evpn’, u’fabric-interface’]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Type of service assigned for this object

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 ServiceObject objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Links the service-connection-module to a service object.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_service_object(ref_obj)

Add service-object to service-connection-module.

Parameters:ref_obj – ServiceObject object
add_tag(ref_obj)

Add tag to service-connection-module.

Parameters:ref_obj – Tag object
annotations

Get annotations for service-connection-module.

Returns:KeyValuePairs object
display_name

Get display-name for service-connection-module.

Returns:xsd:string object
dump()

Display service-connection-module object in compact form.

e2_service

Get e2-service for service-connection-module.

Returns:E2servicetype object
get_fq_name()

Return FQN of service-connection-module in list form.

get_fq_name_str()

Return FQN of service-connection-module as colon delimited string.

get_service_endpoint_back_refs()

Return list of all service-endpoints using this service-connection-module

get_service_object_refs()

Return service-object list for service-connection-module.

Returns:list of <ServiceObject>
get_tag_refs()

Return tag list for service-connection-module.

Returns:list of <Tag>
get_type()

Return object type (service-connection-module).

id_perms

Get id-perms for service-connection-module.

Returns:IdPermsType object
perms2

Get perms2 for service-connection-module.

Returns:PermType2 object
service_type

Get service-type for service-connection-module.

Returns:ServiceConnectionType object
set_service_object(ref_obj)

Set service-object for service-connection-module.

Parameters:ref_obj – ServiceObject object
set_service_object_list(ref_obj_list)

Set service-object list for service-connection-module.

Parameters:ref_obj_list – list of ServiceObject object
set_tag(ref_obj)

Set tag for service-connection-module.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for service-connection-module.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.ServiceEndpoint(name=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 ServiceConnectionModule objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Link the service endpoint to service connection node

  • list of PhysicalRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to Router for a given service.

  • list of ServiceObject objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Links the service-endpoints to a service object.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_physical_router(ref_obj)

Add physical-router to service-endpoint.

Parameters:ref_obj – PhysicalRouter object
add_service_connection_module(ref_obj)

Add service-connection-module to service-endpoint.

Parameters:ref_obj – ServiceConnectionModule object
add_service_object(ref_obj)

Add service-object to service-endpoint.

Parameters:ref_obj – ServiceObject object
add_tag(ref_obj)

Add tag to service-endpoint.

Parameters:ref_obj – Tag object
annotations

Get annotations for service-endpoint.

Returns:KeyValuePairs object
display_name

Get display-name for service-endpoint.

Returns:xsd:string object
dump()

Display service-endpoint object in compact form.

get_fq_name()

Return FQN of service-endpoint in list form.

get_fq_name_str()

Return FQN of service-endpoint as colon delimited string.

get_physical_router_refs()

Return physical-router list for service-endpoint.

Returns:list of <PhysicalRouter>
get_service_connection_module_refs()

Return service-connection-module list for service-endpoint.

Returns:list of <ServiceConnectionModule>
get_service_object_refs()

Return service-object list for service-endpoint.

Returns:list of <ServiceObject>
get_tag_refs()

Return tag list for service-endpoint.

Returns:list of <Tag>
get_type()

Return object type (service-endpoint).

get_virtual_machine_interface_back_refs()

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

id_perms

Get id-perms for service-endpoint.

Returns:IdPermsType object
perms2

Get perms2 for service-endpoint.

Returns:PermType2 object
set_physical_router(ref_obj)

Set physical-router for service-endpoint.

Parameters:ref_obj – PhysicalRouter object
set_physical_router_list(ref_obj_list)

Set physical-router list for service-endpoint.

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

Set service-connection-module for service-endpoint.

Parameters:ref_obj – ServiceConnectionModule object
set_service_connection_module_list(ref_obj_list)

Set service-connection-module list for service-endpoint.

Parameters:ref_obj_list – list of ServiceConnectionModule object
set_service_object(ref_obj)

Set service-object for service-endpoint.

Parameters:ref_obj – ServiceObject object
set_service_object_list(ref_obj_list)

Set service-object list for service-endpoint.

Parameters:ref_obj_list – list of ServiceObject object
set_tag(ref_obj)

Set tag for service-endpoint.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for service-endpoint.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.ServiceGroup(name=None, parent_obj=None, draft_mode_state=None, service_group_firewall_service_list=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

When parent is policy-management:
Service Group object
When parent is project:
Project level service Group object
Created By:
User when parent is PolicyManagement User when parent is Project
Child of:
PolicyManagement object OR Project object
Properties:
  • draft_mode_state

    Type: str, one-of [u’created’, u’updated’, u’deleted’]

    Created By: User (optional)

    Operations Allowed: R

    Description:

  • service_group_firewall_service_list

    Type: FirewallServiceGroupType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    list of service objects (protocol, source port and destination port

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to service-group.

Parameters:ref_obj – Tag object
annotations

Get annotations for service-group.

Returns:KeyValuePairs object
display_name

Get display-name for service-group.

Returns:xsd:string object
draft_mode_state

Get draft-mode-state for service-group.

Returns:DraftModeState object
dump()

Display service-group object in compact form.

get_firewall_rule_back_refs()

Return list of all firewall-rules using this service-group

get_fq_name()

Return FQN of service-group in list form.

get_fq_name_str()

Return FQN of service-group as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for service-group.

Returns:list of <Tag>
get_type()

Return object type (service-group).

id_perms

Get id-perms for service-group.

Returns:IdPermsType object
perms2

Get perms2 for service-group.

Returns:PermType2 object
service_group_firewall_service_list

Get service-group-firewall-service-list for service-group.

Returns:FirewallServiceGroupType object
set_tag(ref_obj)

Set tag for service-group.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for service-group.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.ServiceHealthCheck(name=None, parent_obj=None, service_health_check_properties=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Service health check is a keepalive mechanism 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.

Created By:
User
Child of:
Project object
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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_service_instance(ref_obj, ref_data=None)

Add service-instance to service-health-check.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – ServiceInterfaceTag object
add_tag(ref_obj)

Add tag to service-health-check.

Parameters:ref_obj – Tag object
annotations

Get annotations for service-health-check.

Returns:KeyValuePairs object
display_name

Get display-name for service-health-check.

Returns:xsd:string object
dump()

Display service-health-check object in compact form.

get_bgp_as_a_service_back_refs()

Return list of all bgp-as-a-services using this service-health-check

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_tag_refs()

Return tag list for service-health-check.

Returns:list of <Tag>
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

get_virtual_network_back_refs()

Return list of all virtual-networks 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=None)

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=None)

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

Parameters:
  • ref_obj_list – list of ServiceInstance object
  • ref_data_list – list of ServiceInterfaceTag object
set_tag(ref_obj)

Set tag for service-health-check.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for service-health-check.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.ServiceInstance(name=None, parent_obj=None, service_instance_properties=None, service_instance_bindings=None, service_instance_bgp_enabled=True, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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.

Created By:
User
Child of:
Project object
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.

  • service_instance_bgp_enabled

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Enable BGP routing for this service instance

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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).

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_instance_ip(ref_obj, ref_data=None)

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
add_tag(ref_obj)

Add tag to service-instance.

Parameters:ref_obj – Tag object
annotations

Get annotations for service-instance.

Returns:KeyValuePairs 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_tag_refs()

Return tag list for service-instance.

Returns:list of <Tag>
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_bgp_enabled

Get service-instance-bgp-enabled for service-instance.

Returns:xsd:boolean 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=None)

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=None)

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
set_tag(ref_obj)

Set tag for service-instance.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for service-instance.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.ServiceObject(name=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to service-object.

Parameters:ref_obj – Tag object
annotations

Get annotations for service-object.

Returns:KeyValuePairs object
display_name

Get display-name for service-object.

Returns:xsd:string object
dump()

Display service-object object in compact form.

get_fq_name()

Return FQN of service-object in list form.

get_fq_name_str()

Return FQN of service-object as colon delimited string.

get_service_connection_module_back_refs()

Return list of all service-connection-modules using this service-object

get_service_endpoint_back_refs()

Return list of all service-endpoints using this service-object

get_tag_refs()

Return tag list for service-object.

Returns:list of <Tag>
get_type()

Return object type (service-object).

id_perms

Get id-perms for service-object.

Returns:IdPermsType object
perms2

Get perms2 for service-object.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for service-object.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for service-object.

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

Bases: future.types.newobject.newobject

Service template defines how a service may be deployed in the network. Service instance is instantiated from config in service template.

Created By:
User
Child of:
Domain object
Properties:
  • service_template_properties

    Type: ServiceTemplateType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Service template configuration parameters.

  • service_config_managed

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Enable whether service config for PNFs needs to be managed by Contrail

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 appliance set represented by this service template.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_service_appliance_set(ref_obj)

Add service-appliance-set to service-template.

Parameters:ref_obj – ServiceApplianceSet object
add_tag(ref_obj)

Add tag to service-template.

Parameters:ref_obj – Tag object
annotations

Get annotations for service-template.

Returns:KeyValuePairs 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_tag_refs()

Return tag list for service-template.

Returns:list of <Tag>
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_config_managed

Get service-config-managed for service-template.

Returns:xsd:boolean 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
set_tag(ref_obj)

Set tag for service-template.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for service-template.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.SflowProfile(name=None, parent_obj=None, sflow_profile_is_default=False, sflow_parameters=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

This resource contains information specific to sflow parameters

Created By:
User
Child of:
Project object
Properties:
  • sflow_profile_is_default

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This attribute indicates whether it is a default sflow profile or not. Default profiles are non-

    editable.

  • sflow_parameters

    Type: SflowParameters

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Parameters for each sflow profile, such as polling interval, sample rate, list of sflow enabled

    interfaces, sflow agent ID etc.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to sflow-profile.

Parameters:ref_obj – Tag object
annotations

Get annotations for sflow-profile.

Returns:KeyValuePairs object
display_name

Get display-name for sflow-profile.

Returns:xsd:string object
dump()

Display sflow-profile object in compact form.

get_fq_name()

Return FQN of sflow-profile in list form.

get_fq_name_str()

Return FQN of sflow-profile as colon delimited string.

get_parent_fq_name()

Return FQN of sflow-profile’s parent in list form.

get_parent_fq_name_str()

Return FQN of sflow-profile’s parent as colon delimted string.

get_tag_refs()

Return tag list for sflow-profile.

Returns:list of <Tag>
get_telemetry_profile_back_refs()

Return list of all telemetry-profiles using this sflow-profile

get_type()

Return object type (sflow-profile).

id_perms

Get id-perms for sflow-profile.

Returns:IdPermsType object
perms2

Get perms2 for sflow-profile.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for sflow-profile.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for sflow-profile.

Parameters:ref_obj_list – list of Tag object
sflow_parameters

Get sflow-parameters for sflow-profile.

Returns:SflowParameters object
sflow_profile_is_default

Get sflow-profile-is-default for sflow-profile.

Returns:xsd:boolean object
class gen.resource_common.SnmpProfile(name=None, parent_obj=None, snmp_profile_is_default=False, snmp_parameters=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

This resource contains information specific to snmp parameters

Created By:
User
Child of:
Project object
Properties:
  • snmp_profile_is_default

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This attribute indicates whether it is a default snmp profile or not. Default profiles are non-

    editable.

  • snmp_parameters

    Type: SnmpParameters

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Parameters for each snmp profile like the top level sensor options etc.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to snmp-profile.

Parameters:ref_obj – Tag object
annotations

Get annotations for snmp-profile.

Returns:KeyValuePairs object
display_name

Get display-name for snmp-profile.

Returns:xsd:string object
dump()

Display snmp-profile object in compact form.

get_fq_name()

Return FQN of snmp-profile in list form.

get_fq_name_str()

Return FQN of snmp-profile as colon delimited string.

get_parent_fq_name()

Return FQN of snmp-profile’s parent in list form.

get_parent_fq_name_str()

Return FQN of snmp-profile’s parent as colon delimted string.

get_tag_refs()

Return tag list for snmp-profile.

Returns:list of <Tag>
get_telemetry_profile_back_refs()

Return list of all telemetry-profiles using this snmp-profile

get_type()

Return object type (snmp-profile).

id_perms

Get id-perms for snmp-profile.

Returns:IdPermsType object
perms2

Get perms2 for snmp-profile.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for snmp-profile.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for snmp-profile.

Parameters:ref_obj_list – list of Tag object
snmp_parameters

Get snmp-parameters for snmp-profile.

Returns:SnmpParameters object
snmp_profile_is_default

Get snmp-profile-is-default for snmp-profile.

Returns:xsd:boolean object
class gen.resource_common.StormControlProfile(name=None, parent_obj=None, storm_control_parameters=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Storm control profile definition

Created By:
User
Child of:
Project object
Properties:
  • storm_control_parameters

    Type: StormControlParameters

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Parameters for the storm control profile, such as bandwidth percentage, actions, traffic type,

    receovery timeout etc.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to storm-control-profile.

Parameters:ref_obj – Tag object
annotations

Get annotations for storm-control-profile.

Returns:KeyValuePairs object
display_name

Get display-name for storm-control-profile.

Returns:xsd:string object
dump()

Display storm-control-profile object in compact form.

get_fq_name()

Return FQN of storm-control-profile in list form.

get_fq_name_str()

Return FQN of storm-control-profile as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

Return FQN of storm-control-profile’s parent as colon delimted string.

get_port_profile_back_refs()

Return list of all port-profiles using this storm-control-profile

get_tag_refs()

Return tag list for storm-control-profile.

Returns:list of <Tag>
get_type()

Return object type (storm-control-profile).

id_perms

Get id-perms for storm-control-profile.

Returns:IdPermsType object
perms2

Get perms2 for storm-control-profile.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for storm-control-profile.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for storm-control-profile.

Parameters:ref_obj_list – list of Tag object
storm_control_parameters

Get storm-control-parameters for storm-control-profile.

Returns:StormControlParameters object
class gen.resource_common.StructuredSyslogApplicationRecord(name=None, parent_obj=None, structured_syslog_app_category=None, structured_syslog_app_subcategory=None, structured_syslog_app_groups=None, structured_syslog_app_risk=None, structured_syslog_app_service_tags=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

mapping App name to other entities

Created By:
User
Child of:
StructuredSyslogConfig object
Properties:
  • structured_syslog_app_category

    Type: str

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    The application category

  • structured_syslog_app_subcategory

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    The application sub category

  • structured_syslog_app_groups

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    app groups comma separated

  • structured_syslog_app_risk

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    The application risk profile

  • structured_syslog_app_service_tags

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    service-tags corresponding to applications

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to structured-syslog-application-record.

Parameters:ref_obj – Tag object
annotations

Get annotations for structured-syslog-application-record.

Returns:KeyValuePairs object
display_name

Get display-name for structured-syslog-application-record.

Returns:xsd:string object
dump()

Display structured-syslog-application-record object in compact form.

get_fq_name()

Return FQN of structured-syslog-application-record in list form.

get_fq_name_str()

Return FQN of structured-syslog-application-record as colon delimited string.

get_parent_fq_name()

Return FQN of structured-syslog-application-record’s parent in list form.

get_parent_fq_name_str()

Return FQN of structured-syslog-application-record’s parent as colon delimted string.

get_tag_refs()

Return tag list for structured-syslog-application-record.

Returns:list of <Tag>
get_type()

Return object type (structured-syslog-application-record).

id_perms

Get id-perms for structured-syslog-application-record.

Returns:IdPermsType object
perms2

Get perms2 for structured-syslog-application-record.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for structured-syslog-application-record.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for structured-syslog-application-record.

Parameters:ref_obj_list – list of Tag object
structured_syslog_app_category

Get structured-syslog-app-category for structured-syslog-application-record.

Returns:xsd:string object
structured_syslog_app_groups

Get structured-syslog-app-groups for structured-syslog-application-record.

Returns:xsd:string object
structured_syslog_app_risk

Get structured-syslog-app-risk for structured-syslog-application-record.

Returns:xsd:string object
structured_syslog_app_service_tags

Get structured-syslog-app-service-tags for structured-syslog-application-record.

Returns:xsd:string object
structured_syslog_app_subcategory

Get structured-syslog-app-subcategory for structured-syslog-application-record.

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

Bases: future.types.newobject.newobject

structured syslog config related data

Created By:
User when parent is GlobalAnalyticsConfig User when parent is Project
Child of:
GlobalAnalyticsConfig object OR Project object
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 StructuredSyslogMessage objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of structured-syslog-message that are applicable to objects anchored under

    structured-syslog-config.

  • list of StructuredSyslogHostnameRecord objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of structured-syslog-hostname-record that are applicable to objects anchored

    under structured-syslog-config.

  • list of StructuredSyslogTenantRecord objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of structured-syslog-tenant-record that are applicable to objects anchored

    under structured-syslog-config.

  • list of StructuredSyslogApplicationRecord objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of structured-syslog-application-record that are applicable to objects anchored

    under structured-syslog-config.

  • list of StructuredSyslogSlaProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of structured-syslog-sla-profile that are applicable to objects anchored under

    structured-syslog-config.

References to:
  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to structured-syslog-config.

Parameters:ref_obj – Tag object
annotations

Get annotations for structured-syslog-config.

Returns:KeyValuePairs object
display_name

Get display-name for structured-syslog-config.

Returns:xsd:string object
dump()

Display structured-syslog-config object in compact form.

get_fq_name()

Return FQN of structured-syslog-config in list form.

get_fq_name_str()

Return FQN of structured-syslog-config as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for structured-syslog-config.

Returns:list of <Tag>
get_type()

Return object type (structured-syslog-config).

id_perms

Get id-perms for structured-syslog-config.

Returns:IdPermsType object
perms2

Get perms2 for structured-syslog-config.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for structured-syslog-config.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for structured-syslog-config.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.StructuredSyslogHostnameRecord(name=None, parent_obj=None, structured_syslog_hostaddr=None, structured_syslog_tenant=None, structured_syslog_location=None, structured_syslog_device=None, structured_syslog_hostname_tags=None, structured_syslog_linkmap=None, structured_syslog_lan_segment_list=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

mapping Hostname to other entities

Created By:
User
Child of:
StructuredSyslogConfig object
Properties:
  • structured_syslog_hostaddr

    Type: str

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    The host address

  • structured_syslog_tenant

    Type: str

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    The tenant name

  • structured_syslog_location

    Type: str

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    location details

  • structured_syslog_device

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    device id

  • structured_syslog_hostname_tags

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    tags corresponding to the host

  • structured_syslog_linkmap

    Type: StructuredSyslogLinkmap

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    overlay to underlay mapping

  • structured_syslog_lan_segment_list

    Type: StructuredSyslogLANSegmentList

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    vpn to network-ranges mapping

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to structured-syslog-hostname-record.

Parameters:ref_obj – Tag object
annotations

Get annotations for structured-syslog-hostname-record.

Returns:KeyValuePairs object
display_name

Get display-name for structured-syslog-hostname-record.

Returns:xsd:string object
dump()

Display structured-syslog-hostname-record object in compact form.

get_fq_name()

Return FQN of structured-syslog-hostname-record in list form.

get_fq_name_str()

Return FQN of structured-syslog-hostname-record as colon delimited string.

get_parent_fq_name()

Return FQN of structured-syslog-hostname-record’s parent in list form.

get_parent_fq_name_str()

Return FQN of structured-syslog-hostname-record’s parent as colon delimted string.

get_tag_refs()

Return tag list for structured-syslog-hostname-record.

Returns:list of <Tag>
get_type()

Return object type (structured-syslog-hostname-record).

id_perms

Get id-perms for structured-syslog-hostname-record.

Returns:IdPermsType object
perms2

Get perms2 for structured-syslog-hostname-record.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for structured-syslog-hostname-record.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for structured-syslog-hostname-record.

Parameters:ref_obj_list – list of Tag object
structured_syslog_device

Get structured-syslog-device for structured-syslog-hostname-record.

Returns:xsd:string object
structured_syslog_hostaddr

Get structured-syslog-hostaddr for structured-syslog-hostname-record.

Returns:xsd:string object
structured_syslog_hostname_tags

Get structured-syslog-hostname-tags for structured-syslog-hostname-record.

Returns:xsd:string object
structured_syslog_lan_segment_list

Get structured-syslog-lan-segment-list for structured-syslog-hostname-record.

Returns:StructuredSyslogLANSegmentList object
structured_syslog_linkmap

Get structured-syslog-linkmap for structured-syslog-hostname-record.

Returns:StructuredSyslogLinkmap object
structured_syslog_location

Get structured-syslog-location for structured-syslog-hostname-record.

Returns:xsd:string object
structured_syslog_tenant

Get structured-syslog-tenant for structured-syslog-hostname-record.

Returns:xsd:string object
class gen.resource_common.StructuredSyslogMessage(name=None, parent_obj=None, structured_syslog_message_tagged_fields=None, structured_syslog_message_integer_fields=None, structured_syslog_message_process_and_store=False, structured_syslog_message_process_and_summarize=False, structured_syslog_message_process_and_summarize_user=False, structured_syslog_message_forward=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

structured syslog messages to be handled

Created By:
User
Child of:
StructuredSyslogConfig object
Properties:
  • structured_syslog_message_tagged_fields

    Type: FieldNamesList

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    list of field names in the message to be tagged

  • structured_syslog_message_integer_fields

    Type: FieldNamesList

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    list of integer fields in the message

  • structured_syslog_message_process_and_store

    Type: bool

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    message is to be processed and stored or not

  • structured_syslog_message_process_and_summarize

    Type: bool

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    message is to be processed and summarized or not

  • structured_syslog_message_process_and_summarize_user

    Type: bool

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    message is to be processed and summarized for user or not

  • structured_syslog_message_forward

    Type: str, one-of [u’do-not-forward’, u’forward-unprocessed’, u’forward-processed’]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    fowarding action to be taken on the message

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to structured-syslog-message.

Parameters:ref_obj – Tag object
annotations

Get annotations for structured-syslog-message.

Returns:KeyValuePairs object
display_name

Get display-name for structured-syslog-message.

Returns:xsd:string object
dump()

Display structured-syslog-message object in compact form.

get_fq_name()

Return FQN of structured-syslog-message in list form.

get_fq_name_str()

Return FQN of structured-syslog-message as colon delimited string.

get_parent_fq_name()

Return FQN of structured-syslog-message’s parent in list form.

get_parent_fq_name_str()

Return FQN of structured-syslog-message’s parent as colon delimted string.

get_tag_refs()

Return tag list for structured-syslog-message.

Returns:list of <Tag>
get_type()

Return object type (structured-syslog-message).

id_perms

Get id-perms for structured-syslog-message.

Returns:IdPermsType object
perms2

Get perms2 for structured-syslog-message.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for structured-syslog-message.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for structured-syslog-message.

Parameters:ref_obj_list – list of Tag object
structured_syslog_message_forward

Get structured-syslog-message-forward for structured-syslog-message.

Returns:StructuredSyslogMessageForwardType object
structured_syslog_message_integer_fields

Get structured-syslog-message-integer-fields for structured-syslog-message.

Returns:FieldNamesList object
structured_syslog_message_process_and_store

Get structured-syslog-message-process-and-store for structured-syslog-message.

Returns:xsd:boolean object
structured_syslog_message_process_and_summarize

Get structured-syslog-message-process-and-summarize for structured-syslog-message.

Returns:xsd:boolean object
structured_syslog_message_process_and_summarize_user

Get structured-syslog-message-process-and-summarize-user for structured-syslog-message.

Returns:xsd:boolean object
structured_syslog_message_tagged_fields

Get structured-syslog-message-tagged-fields for structured-syslog-message.

Returns:FieldNamesList object
class gen.resource_common.StructuredSyslogSlaProfile(name=None, parent_obj=None, structured_syslog_sla_params=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

mapping sla-profile to sla params

Created By:
User
Child of:
StructuredSyslogConfig object
Properties:
  • structured_syslog_sla_params

    Type: str

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    The sla params like sampling %age and

    traffic type

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to structured-syslog-sla-profile.

Parameters:ref_obj – Tag object
annotations

Get annotations for structured-syslog-sla-profile.

Returns:KeyValuePairs object
display_name

Get display-name for structured-syslog-sla-profile.

Returns:xsd:string object
dump()

Display structured-syslog-sla-profile object in compact form.

get_fq_name()

Return FQN of structured-syslog-sla-profile in list form.

get_fq_name_str()

Return FQN of structured-syslog-sla-profile as colon delimited string.

get_parent_fq_name()

Return FQN of structured-syslog-sla-profile’s parent in list form.

get_parent_fq_name_str()

Return FQN of structured-syslog-sla-profile’s parent as colon delimted string.

get_tag_refs()

Return tag list for structured-syslog-sla-profile.

Returns:list of <Tag>
get_type()

Return object type (structured-syslog-sla-profile).

id_perms

Get id-perms for structured-syslog-sla-profile.

Returns:IdPermsType object
perms2

Get perms2 for structured-syslog-sla-profile.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for structured-syslog-sla-profile.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for structured-syslog-sla-profile.

Parameters:ref_obj_list – list of Tag object
structured_syslog_sla_params

Get structured-syslog-sla-params for structured-syslog-sla-profile.

Returns:xsd:string object
class gen.resource_common.StructuredSyslogTenantRecord(name=None, parent_obj=None, structured_syslog_tenant=None, structured_syslog_tenantaddr=None, structured_syslog_tenant_tags=None, structured_syslog_dscpmap=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

mapping Tenant to other entities

Created By:
User
Child of:
StructuredSyslogConfig object
Properties:
  • structured_syslog_tenant

    Type: str

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    The tenant name

  • structured_syslog_tenantaddr

    Type: str

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    The tenant address

  • structured_syslog_tenant_tags

    Type: str

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    tags corresponding to the tenant

  • structured_syslog_dscpmap

    Type: StructuredSyslogDSCPMap

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    dscp to Alias mapping

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to structured-syslog-tenant-record.

Parameters:ref_obj – Tag object
annotations

Get annotations for structured-syslog-tenant-record.

Returns:KeyValuePairs object
display_name

Get display-name for structured-syslog-tenant-record.

Returns:xsd:string object
dump()

Display structured-syslog-tenant-record object in compact form.

get_fq_name()

Return FQN of structured-syslog-tenant-record in list form.

get_fq_name_str()

Return FQN of structured-syslog-tenant-record as colon delimited string.

get_parent_fq_name()

Return FQN of structured-syslog-tenant-record’s parent in list form.

get_parent_fq_name_str()

Return FQN of structured-syslog-tenant-record’s parent as colon delimted string.

get_tag_refs()

Return tag list for structured-syslog-tenant-record.

Returns:list of <Tag>
get_type()

Return object type (structured-syslog-tenant-record).

id_perms

Get id-perms for structured-syslog-tenant-record.

Returns:IdPermsType object
perms2

Get perms2 for structured-syslog-tenant-record.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for structured-syslog-tenant-record.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for structured-syslog-tenant-record.

Parameters:ref_obj_list – list of Tag object
structured_syslog_dscpmap

Get structured-syslog-dscpmap for structured-syslog-tenant-record.

Returns:StructuredSyslogDSCPMap object
structured_syslog_tenant

Get structured-syslog-tenant for structured-syslog-tenant-record.

Returns:xsd:string object
structured_syslog_tenant_tags

Get structured-syslog-tenant-tags for structured-syslog-tenant-record.

Returns:xsd:string object
structured_syslog_tenantaddr

Get structured-syslog-tenantaddr for structured-syslog-tenant-record.

Returns:xsd:string object
class gen.resource_common.SubCluster(name=None, sub_cluster_asn=None, sub_cluster_id=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

Properties:
  • sub_cluster_asn

    Type: int, within [1, 4294967295]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    AS number of that cluster.

  • sub_cluster_id

    Type: int, within [1, 4294967295]

    Created By: System

    Operations Allowed: R

    Description:

    Unique 16 or 32 bit ID assigned to this sub-cluster. User can define the ID he wants to use.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to sub-cluster.

Parameters:ref_obj – Tag object
annotations

Get annotations for sub-cluster.

Returns:KeyValuePairs object
display_name

Get display-name for sub-cluster.

Returns:xsd:string object
dump()

Display sub-cluster object in compact form.

get_bgp_router_back_refs()

Return list of all bgp-routers using this sub-cluster

get_fq_name()

Return FQN of sub-cluster in list form.

get_fq_name_str()

Return FQN of sub-cluster as colon delimited string.

get_tag_refs()

Return tag list for sub-cluster.

Returns:list of <Tag>
get_type()

Return object type (sub-cluster).

get_virtual_router_back_refs()

Return list of all virtual-routers using this sub-cluster

id_perms

Get id-perms for sub-cluster.

Returns:IdPermsType object
perms2

Get perms2 for sub-cluster.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for sub-cluster.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for sub-cluster.

Parameters:ref_obj_list – list of Tag object
sub_cluster_asn

Get sub-cluster-asn for sub-cluster.

Returns:AutonomousSystemType object
sub_cluster_id

Get sub-cluster-id for sub-cluster.

Returns:SubClusterIdType object
class gen.resource_common.Subnet(name=None, subnet_ip_prefix=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 referenced 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.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to subnet.

Parameters:ref_obj – Tag object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to subnet.

Parameters:ref_obj – VirtualMachineInterface object
annotations

Get annotations for subnet.

Returns:KeyValuePairs 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_tag_refs()

Return tag list for subnet.

Returns:list of <Tag>
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_tag(ref_obj)

Set tag for subnet.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for subnet.

Parameters:ref_obj_list – list of Tag 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 gen.resource_common.Tag(name=None, parent_obj=None, tag_type_name=None, tag_value=None, tag_predefined=False, tag_id=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

When parent is config-root:
Attribute attached to objects - has a type and value
When parent is project:
Attribute attached to objects - has a type and value
Created By:
User when parent is ConfigRoot User when parent is Project
Child of:
ConfigRoot object OR Project object
Properties:
  • tag_type_name

    Type: str

    Created By: User (required)

    Operations Allowed: CR

    Description:

    Tag type string representation

  • tag_value

    Type: str

    Created By: User (required)

    Operations Allowed: CR

    Description:

    Tag value string representation

  • tag_predefined

    Type: bool

    Created By: User (optional)

    Operations Allowed: CR

    Description:

    Tag delete boolean representation

  • tag_id

    Type: str, one-of xsd:string

    Created By: User (optional)

    Operations Allowed: R

    Description:

    Internal Tag ID encapsulating tag type and value in hexadecimal fomat: 0xTTTTVVVV

    (T: type, V: value)

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 TagType objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag type reference which is limited to one

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to tag.

Parameters:ref_obj – Tag object
add_tag_type(ref_obj)

Add tag-type to tag.

Parameters:ref_obj – TagType object
annotations

Get annotations for tag.

Returns:KeyValuePairs object
display_name

Get display-name for tag.

Returns:xsd:string object
dump()

Display tag object in compact form.

get_access_control_list_back_refs()

Return list of all access-control-lists using this tag

get_address_group_back_refs()

Return list of all address-groups using this tag

get_alarm_back_refs()

Return list of all alarms using this tag

get_alias_ip_back_refs()

Return list of all alias-ips using this tag

get_alias_ip_pool_back_refs()

Return list of all alias-ip-pools using this tag

get_analytics_alarm_node_back_refs()

Return list of all analytics-alarm-nodes using this tag

get_analytics_node_back_refs()

Return list of all analytics-nodes using this tag

get_analytics_snmp_node_back_refs()

Return list of all analytics-snmp-nodes using this tag

get_api_access_list_back_refs()

Return list of all api-access-lists using this tag

get_application_policy_set_back_refs()

Return list of all application-policy-sets using this tag

get_bgp_as_a_service_back_refs()

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

get_bgp_router_back_refs()

Return list of all bgp-routers using this tag

get_bgpvpn_back_refs()

Return list of all bgpvpns using this tag

get_bridge_domain_back_refs()

Return list of all bridge-domains using this tag

get_card_back_refs()

Return list of all cards using this tag

get_cli_config_back_refs()

Return list of all cli-configs using this tag

get_config_database_node_back_refs()

Return list of all config-database-nodes using this tag

get_config_node_back_refs()

Return list of all config-nodes using this tag

get_config_properties_back_refs()

Return list of all config-propertiess using this tag

get_config_root_back_refs()

Return list of all config-roots using this tag

get_control_node_zone_back_refs()

Return list of all control-node-zones using this tag

get_customer_attachment_back_refs()

Return list of all customer-attachments using this tag

get_data_center_interconnect_back_refs()

Return list of all data-center-interconnects using this tag

get_database_node_back_refs()

Return list of all database-nodes using this tag

get_device_chassis_back_refs()

Return list of all device-chassiss using this tag

get_device_functional_group_back_refs()

Return list of all device-functional-groups using this tag

get_device_image_back_refs()

Return list of all device-images using this tag

get_devicemgr_node_back_refs()

Return list of all devicemgr-nodes using this tag

get_discovery_service_assignment_back_refs()

Return list of all discovery-service-assignments using this tag

get_domain_back_refs()

Return list of all domains using this tag

get_dsa_rule_back_refs()

Return list of all dsa-rules using this tag

get_e2_service_provider_back_refs()

Return list of all e2-service-providers using this tag

get_fabric_back_refs()

Return list of all fabrics using this tag

get_fabric_namespace_back_refs()

Return list of all fabric-namespaces using this tag

get_feature_back_refs()

Return list of all features using this tag

get_feature_config_back_refs()

Return list of all feature-configs using this tag

get_feature_flag_back_refs()

Return list of all feature-flags using this tag

get_firewall_policy_back_refs()

Return list of all firewall-policys using this tag

get_firewall_rule_back_refs()

Return list of all firewall-rules using this tag

get_floating_ip_back_refs()

Return list of all floating-ips using this tag

get_floating_ip_pool_back_refs()

Return list of all floating-ip-pools using this tag

get_flow_node_back_refs()

Return list of all flow-nodes using this tag

get_forwarding_class_back_refs()

Return list of all forwarding-classs using this tag

get_fq_name()

Return FQN of tag in list form.

get_fq_name_str()

Return FQN of tag as colon delimited string.

get_global_analytics_config_back_refs()

Return list of all global-analytics-configs using this tag

get_global_qos_config_back_refs()

Return list of all global-qos-configs using this tag

get_global_system_config_back_refs()

Return list of all global-system-configs using this tag

get_global_vrouter_config_back_refs()

Return list of all global-vrouter-configs using this tag

get_grpc_profile_back_refs()

Return list of all grpc-profiles using this tag

get_hardware_back_refs()

Return list of all hardwares using this tag

get_hardware_inventory_back_refs()

Return list of all hardware-inventorys using this tag

get_host_based_service_back_refs()

Return list of all host-based-services using this tag

get_instance_ip_back_refs()

Return list of all instance-ips using this tag

get_intent_map_back_refs()

Return list of all intent-maps using this tag

get_interface_route_table_back_refs()

Return list of all interface-route-tables using this tag

get_job_template_back_refs()

Return list of all job-templates using this tag

Return list of all link-aggregation-groups using this tag

get_loadbalancer_back_refs()

Return list of all loadbalancers using this tag

get_loadbalancer_healthmonitor_back_refs()

Return list of all loadbalancer-healthmonitors using this tag

get_loadbalancer_listener_back_refs()

Return list of all loadbalancer-listeners using this tag

get_loadbalancer_member_back_refs()

Return list of all loadbalancer-members using this tag

get_loadbalancer_pool_back_refs()

Return list of all loadbalancer-pools using this tag

get_logical_interface_back_refs()

Return list of all logical-interfaces using this tag

get_logical_router_back_refs()

Return list of all logical-routers using this tag

get_multicast_policy_back_refs()

Return list of all multicast-policys using this tag

get_namespace_back_refs()

Return list of all namespaces using this tag

get_netconf_profile_back_refs()

Return list of all netconf-profiles using this tag

get_network_device_config_back_refs()

Return list of all network-device-configs using this tag

get_network_ipam_back_refs()

Return list of all network-ipams using this tag

get_network_policy_back_refs()

Return list of all network-policys using this tag

get_node_back_refs()

Return list of all nodes using this tag

get_node_profile_back_refs()

Return list of all node-profiles using this tag

get_overlay_role_back_refs()

Return list of all overlay-roles using this tag

get_parent_fq_name()

Return FQN of tag’s parent in list form.

get_parent_fq_name_str()

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

get_peering_policy_back_refs()

Return list of all peering-policys using this tag

get_physical_interface_back_refs()

Return list of all physical-interfaces using this tag

get_physical_role_back_refs()

Return list of all physical-roles using this tag

get_physical_router_back_refs()

Return list of all physical-routers using this tag

get_policy_management_back_refs()

Return list of all policy-managements using this tag

get_port_back_refs()

Return list of all ports using this tag

get_port_group_back_refs()

Return list of all port-groups using this tag

get_port_profile_back_refs()

Return list of all port-profiles using this tag

get_port_tuple_back_refs()

Return list of all port-tuples using this tag

get_project_back_refs()

Return list of all projects using this tag

get_provider_attachment_back_refs()

Return list of all provider-attachments using this tag

get_qos_config_back_refs()

Return list of all qos-configs using this tag

get_qos_queue_back_refs()

Return list of all qos-queues using this tag

get_role_config_back_refs()

Return list of all role-configs using this tag

get_role_definition_back_refs()

Return list of all role-definitions using this tag

get_route_aggregate_back_refs()

Return list of all route-aggregates using this tag

get_route_table_back_refs()

Return list of all route-tables using this tag

get_route_target_back_refs()

Return list of all route-targets using this tag

get_routing_instance_back_refs()

Return list of all routing-instances using this tag

get_routing_policy_back_refs()

Return list of all routing-policys using this tag

get_security_group_back_refs()

Return list of all security-groups using this tag

get_security_logging_object_back_refs()

Return list of all security-logging-objects using this tag

get_service_appliance_back_refs()

Return list of all service-appliances using this tag

get_service_appliance_set_back_refs()

Return list of all service-appliance-sets using this tag

get_service_connection_module_back_refs()

Return list of all service-connection-modules using this tag

get_service_endpoint_back_refs()

Return list of all service-endpoints using this tag

get_service_group_back_refs()

Return list of all service-groups using this tag

get_service_health_check_back_refs()

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

get_service_instance_back_refs()

Return list of all service-instances using this tag

get_service_object_back_refs()

Return list of all service-objects using this tag

get_service_template_back_refs()

Return list of all service-templates using this tag

get_sflow_profile_back_refs()

Return list of all sflow-profiles using this tag

get_snmp_profile_back_refs()

Return list of all snmp-profiles using this tag

get_storm_control_profile_back_refs()

Return list of all storm-control-profiles using this tag

get_structured_syslog_application_record_back_refs()

Return list of all structured-syslog-application-records using this tag

get_structured_syslog_config_back_refs()

Return list of all structured-syslog-configs using this tag

get_structured_syslog_hostname_record_back_refs()

Return list of all structured-syslog-hostname-records using this tag

get_structured_syslog_message_back_refs()

Return list of all structured-syslog-messages using this tag

get_structured_syslog_sla_profile_back_refs()

Return list of all structured-syslog-sla-profiles using this tag

get_structured_syslog_tenant_record_back_refs()

Return list of all structured-syslog-tenant-records using this tag

get_sub_cluster_back_refs()

Return list of all sub-clusters using this tag

get_subnet_back_refs()

Return list of all subnets using this tag

get_tag_back_refs()

Return list of all tags using this tag

get_tag_refs()

Return tag list for tag.

Returns:list of <Tag>
get_tag_type_back_refs()

Return list of all tag-types using this tag

get_tag_type_refs()

Return tag-type list for tag.

Returns:list of <TagType>
get_telemetry_profile_back_refs()

Return list of all telemetry-profiles using this tag

get_type()

Return object type (tag).

get_virtual_DNS_back_refs()

Return list of all virtual-DNSs using this tag

get_virtual_DNS_record_back_refs()

Return list of all virtual-DNS-records using this tag

get_virtual_ip_back_refs()

Return list of all virtual-ips using this tag

get_virtual_machine_back_refs()

Return list of all virtual-machines using this tag

get_virtual_machine_interface_back_refs()

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

get_virtual_network_back_refs()

Return list of all virtual-networks using this tag

get_virtual_port_group_back_refs()

Return list of all virtual-port-groups using this tag

get_virtual_router_back_refs()

Return list of all virtual-routers using this tag

get_webui_node_back_refs()

Return list of all webui-nodes using this tag

id_perms

Get id-perms for tag.

Returns:IdPermsType object
perms2

Get perms2 for tag.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for tag.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for tag.

Parameters:ref_obj_list – list of Tag object
set_tag_type(ref_obj)

Set tag-type for tag.

Parameters:ref_obj – TagType object
set_tag_type_list(ref_obj_list)

Set tag-type list for tag.

Parameters:ref_obj_list – list of TagType object
tag_id

Get tag-id for tag.

Returns:U32BitHexInt object
tag_predefined

Get tag-predefined for tag.

Returns:xsd:boolean object
tag_type_name

Get tag-type-name for tag.

Returns:xsd:string object
tag_value

Get tag-value for tag.

Returns:xsd:string object
class gen.resource_common.TagType(name=None, tag_type_id=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

Properties:
  • tag_type_id

    Type: str, one-of xsd:string

    Created By: User (required)

    Operations Allowed: R

    Description:

    Internal Tag type ID coded on 16 bits where the first 255 IDs are reserved

    and pre-defined. Users (principally cloud admin) can define arbitrary types but its

    automatically shared to all project as it is a global resource.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
  • list of Tag objects
add_tag(ref_obj)

Add tag to tag-type.

Parameters:ref_obj – Tag object
annotations

Get annotations for tag-type.

Returns:KeyValuePairs object
display_name

Get display-name for tag-type.

Returns:xsd:string object
dump()

Display tag-type object in compact form.

get_fq_name()

Return FQN of tag-type in list form.

get_fq_name_str()

Return FQN of tag-type as colon delimited string.

get_tag_back_refs()

Return list of all tags using this tag-type

get_tag_refs()

Return tag list for tag-type.

Returns:list of <Tag>
get_type()

Return object type (tag-type).

id_perms

Get id-perms for tag-type.

Returns:IdPermsType object
perms2

Get perms2 for tag-type.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for tag-type.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for tag-type.

Parameters:ref_obj_list – list of Tag object
tag_type_id

Get tag-type-id for tag-type.

Returns:U16BitHexInt object
class gen.resource_common.TelemetryProfile(name=None, parent_obj=None, telemetry_profile_is_default=False, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Encapsulates data related to telemetry from network devices like sflow, JTI, gRPC, SNMP etc

Created By:
User
Child of:
Project object
Properties:
  • telemetry_profile_is_default

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This attribute indicates whether it is a default telemetry profile or not. Default profiles are non-

    editable.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 SflowProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Sflow profile that this telemetry profile uses. Only one sflow profile can be associated to one

    telemetry profile.

  • list of GrpcProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    gRPC profile that this telemetry profile uses. Only one gRPC profile can be associated to one

    telemetry profile.

  • list of NetconfProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    netconf profile that this telemetry profile uses. Only one netconf profile can be associated to one

    telemetry profile.

  • list of SnmpProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    snmp profile that this telemetry profile uses. Only one snmp profile can be associated to one

    telemetry profile.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_grpc_profile(ref_obj)

Add grpc-profile to telemetry-profile.

Parameters:ref_obj – GrpcProfile object
add_netconf_profile(ref_obj)

Add netconf-profile to telemetry-profile.

Parameters:ref_obj – NetconfProfile object
add_sflow_profile(ref_obj)

Add sflow-profile to telemetry-profile.

Parameters:ref_obj – SflowProfile object
add_snmp_profile(ref_obj)

Add snmp-profile to telemetry-profile.

Parameters:ref_obj – SnmpProfile object
add_tag(ref_obj)

Add tag to telemetry-profile.

Parameters:ref_obj – Tag object
annotations

Get annotations for telemetry-profile.

Returns:KeyValuePairs object
display_name

Get display-name for telemetry-profile.

Returns:xsd:string object
dump()

Display telemetry-profile object in compact form.

get_fq_name()

Return FQN of telemetry-profile in list form.

get_fq_name_str()

Return FQN of telemetry-profile as colon delimited string.

get_grpc_profile_refs()

Return grpc-profile list for telemetry-profile.

Returns:list of <GrpcProfile>
get_netconf_profile_refs()

Return netconf-profile list for telemetry-profile.

Returns:list of <NetconfProfile>
get_parent_fq_name()

Return FQN of telemetry-profile’s parent in list form.

get_parent_fq_name_str()

Return FQN of telemetry-profile’s parent as colon delimted string.

get_physical_router_back_refs()

Return list of all physical-routers using this telemetry-profile

get_sflow_profile_refs()

Return sflow-profile list for telemetry-profile.

Returns:list of <SflowProfile>
get_snmp_profile_refs()

Return snmp-profile list for telemetry-profile.

Returns:list of <SnmpProfile>
get_tag_refs()

Return tag list for telemetry-profile.

Returns:list of <Tag>
get_type()

Return object type (telemetry-profile).

id_perms

Get id-perms for telemetry-profile.

Returns:IdPermsType object
perms2

Get perms2 for telemetry-profile.

Returns:PermType2 object
set_grpc_profile(ref_obj)

Set grpc-profile for telemetry-profile.

Parameters:ref_obj – GrpcProfile object
set_grpc_profile_list(ref_obj_list)

Set grpc-profile list for telemetry-profile.

Parameters:ref_obj_list – list of GrpcProfile object
set_netconf_profile(ref_obj)

Set netconf-profile for telemetry-profile.

Parameters:ref_obj – NetconfProfile object
set_netconf_profile_list(ref_obj_list)

Set netconf-profile list for telemetry-profile.

Parameters:ref_obj_list – list of NetconfProfile object
set_sflow_profile(ref_obj)

Set sflow-profile for telemetry-profile.

Parameters:ref_obj – SflowProfile object
set_sflow_profile_list(ref_obj_list)

Set sflow-profile list for telemetry-profile.

Parameters:ref_obj_list – list of SflowProfile object
set_snmp_profile(ref_obj)

Set snmp-profile for telemetry-profile.

Parameters:ref_obj – SnmpProfile object
set_snmp_profile_list(ref_obj_list)

Set snmp-profile list for telemetry-profile.

Parameters:ref_obj_list – list of SnmpProfile object
set_tag(ref_obj)

Set tag for telemetry-profile.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for telemetry-profile.

Parameters:ref_obj_list – list of Tag object
telemetry_profile_is_default

Get telemetry-profile-is-default for telemetry-profile.

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

Bases: future.types.newobject.newobject

Virtual DNS server is DNS as service for tenants. It is inbound DNS service for virtual machines in this project. DNS requests by end points inside this project/IPAM are served by this DNS server rules.

Created By:
User
Child of:
Domain object
Properties:
  • virtual_DNS_data

    Type: VirtualDnsType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

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

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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:
  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_tag(ref_obj)

Add tag to virtual-DNS.

Parameters:ref_obj – Tag object
annotations

Get annotations for virtual-DNS.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for virtual-DNS.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for virtual-DNS.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for virtual-DNS.

Parameters:ref_obj_list – list of Tag object
virtual_DNS_data

Get virtual-DNS-data for virtual-DNS.

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

Bases: future.types.newobject.newobject

Static DNS records in virtual DNS server.

Created By:
User
Child of:
VirtualDns object
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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to virtual-DNS-record.

Parameters:ref_obj – Tag object
annotations

Get annotations for virtual-DNS-record.

Returns:KeyValuePairs object
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_tag_refs()

Return tag list for virtual-DNS-record.

Returns:list of <Tag>
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
set_tag(ref_obj)

Set tag for virtual-DNS-record.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for virtual-DNS-record.

Parameters:ref_obj_list – list of Tag object
virtual_DNS_record_data

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

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

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
Project object
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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_loadbalancer_pool(ref_obj)

Add loadbalancer-pool to virtual-ip.

Parameters:ref_obj – LoadbalancerPool object
add_tag(ref_obj)

Add tag to virtual-ip.

Parameters:ref_obj – Tag object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to virtual-ip.

Parameters:ref_obj – VirtualMachineInterface object
annotations

Get annotations for virtual-ip.

Returns:KeyValuePairs 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_tag_refs()

Return tag list for virtual-ip.

Returns:list of <Tag>
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_tag(ref_obj)

Set tag for virtual-ip.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for virtual-ip.

Parameters:ref_obj_list – list of Tag 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 gen.resource_common.VirtualMachine(name=None, server_type='virtual-server', id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

Created By:

Properties:
  • server_type

    Type: str, one-of [u’virtual-server’, u’baremetal-server’, u’container’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    An enumeration value specifying the server type.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 DEPRECATED.

References to:
  • list of ServiceInstance objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Reference to the service instance of this virtual machine.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_service_instance(ref_obj)

Add service-instance to virtual-machine.

Parameters:ref_obj – ServiceInstance object
add_tag(ref_obj)

Add tag to virtual-machine.

Parameters:ref_obj – Tag object
annotations

Get annotations for virtual-machine.

Returns:KeyValuePairs 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_tag_refs()

Return tag list for virtual-machine.

Returns:list of <Tag>
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
server_type

Get server-type for virtual-machine.

Returns:ServerType 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
set_tag(ref_obj)

Set tag for virtual-machine.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for virtual-machine.

Parameters:ref_obj_list – list of Tag object
class gen.resource_common.VirtualMachineInterface(name=None, parent_obj=None, ecmp_hashing_include_fields=None, port_security_enabled=True, 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, vlan_tag_based_bridge_domain=False, igmp_enable=False, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

When parent is virtual-machine:
References to child interfaces this virtual machine has, this is DEPRECATED.
When parent is project:
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.
When parent is virtual-router:
An interface on a virtual-router, e.g. vhost0
Created By:
User when parent is VirtualMachine User when parent is Project User when parent is VirtualRouter
Child of:
VirtualMachine object OR Project object OR VirtualRouter object
Properties:
  • ecmp_hashing_include_fields

    Type: EcmpHashingIncludeFields

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    ECMP hashing config at global level.

  • port_security_enabled

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Port security status on the network

  • 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: str

    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. Features that require policy will not work on this interface, these

    include security group, floating IP, service chain, linklocal services.

  • virtual_machine_interface_properties

    Type: VirtualMachineInterfacePropertiesType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Virtual Machine Interface miscellaneous 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.

  • vlan_tag_based_bridge_domain

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Enable VLAN tag based bridge domain classification on the port

  • igmp_enable

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    IGMP mode at Global level.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 SecurityLoggingObject objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to security logging object for this virtual machine interface

  • 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 deprecated in future in favour of VRF assign

    rules.

  • list of BgpRouter objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Reference to bgp-router from the virtual machine interface.

  • 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, management, other1).

  • list of ServiceHealthCheck objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference 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.

  • list of (BridgeDomain object, BridgeDomainMembershipType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Virtual Machine interface maps to a bridge-domain by defaultor based on in coming 802.1Q vlan tag

  • list of ServiceEndpoint objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Links the access endpoint i.e virtual-machine-interface to service endpoint.

  • list of (VirtualPortGroup object, VMIVirtualPortGroupAttributes attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    virtual port group to which this virtaul machine interface is attached

  • list of PortProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Port profiles attached to this virtual machine interface

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_bgp_router(ref_obj)

Add bgp-router to virtual-machine-interface.

Parameters:ref_obj – BgpRouter object
add_bridge_domain(ref_obj, ref_data=None)

Add bridge-domain to virtual-machine-interface.

Parameters:
  • ref_obj – BridgeDomain object
  • ref_data – BridgeDomainMembershipType object
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_profile(ref_obj)

Add port-profile to virtual-machine-interface.

Parameters:ref_obj – PortProfile 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=None)

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_security_logging_object(ref_obj)

Add security-logging-object to virtual-machine-interface.

Parameters:ref_obj – SecurityLoggingObject object
add_service_endpoint(ref_obj)

Add service-endpoint to virtual-machine-interface.

Parameters:ref_obj – ServiceEndpoint object
add_service_health_check(ref_obj)

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

Parameters:ref_obj – ServiceHealthCheck object
add_tag(ref_obj)

Add tag to virtual-machine-interface.

Parameters:ref_obj – Tag 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
add_virtual_port_group(ref_obj, ref_data=None)

Add virtual-port-group to virtual-machine-interface.

Parameters:
  • ref_obj – VirtualPortGroup object
  • ref_data – VMIVirtualPortGroupAttributes object
annotations

Get annotations for virtual-machine-interface.

Returns:KeyValuePairs 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_bgp_router_refs()

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

Returns:list of <BgpRouter>
get_bridge_domain_refs()

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

Returns:list of tuple <BridgeDomain, BridgeDomainMembershipType>
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>

Return list of all link-aggregation-groups using this virtual-machine-interface

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_profile_refs()

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

Returns:list of <PortProfile>
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_security_logging_object_refs()

Return security-logging-object list for virtual-machine-interface.

Returns:list of <SecurityLoggingObject>
get_service_endpoint_refs()

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

Returns:list of <ServiceEndpoint>
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_tag_refs()

Return tag list for virtual-machine-interface.

Returns:list of <Tag>
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>
get_virtual_port_group_back_refs()

Return list of all virtual-port-groups using this virtual-machine-interface

get_virtual_port_group_refs()

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

Returns:list of tuple <VirtualPortGroup, VMIVirtualPortGroupAttributes>
id_perms

Get id-perms for virtual-machine-interface.

Returns:IdPermsType object
igmp_enable

Get igmp-enable for virtual-machine-interface.

Returns:xsd:boolean object
perms2

Get perms2 for virtual-machine-interface.

Returns:PermType2 object
port_security_enabled

Get port-security-enabled for virtual-machine-interface.

Returns:xsd:boolean object
set_bgp_router(ref_obj)

Set bgp-router for virtual-machine-interface.

Parameters:ref_obj – BgpRouter object
set_bgp_router_list(ref_obj_list)

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

Parameters:ref_obj_list – list of BgpRouter object
set_bridge_domain(ref_obj, ref_data=None)

Set bridge-domain for virtual-machine-interface.

Parameters:
  • ref_obj – BridgeDomain object
  • ref_data – BridgeDomainMembershipType object
set_bridge_domain_list(ref_obj_list, ref_data_list=None)

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

Parameters:
  • ref_obj_list – list of BridgeDomain object
  • ref_data_list – list of BridgeDomainMembershipType 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_profile(ref_obj)

Set port-profile for virtual-machine-interface.

Parameters:ref_obj – PortProfile object
set_port_profile_list(ref_obj_list)

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

Parameters:ref_obj_list – list of PortProfile 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=None)

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=None)

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_security_logging_object(ref_obj)

Set security-logging-object for virtual-machine-interface.

Parameters:ref_obj – SecurityLoggingObject object
set_security_logging_object_list(ref_obj_list)

Set security-logging-object list for virtual-machine-interface.

Parameters:ref_obj_list – list of SecurityLoggingObject object
set_service_endpoint(ref_obj)

Set service-endpoint for virtual-machine-interface.

Parameters:ref_obj – ServiceEndpoint object
set_service_endpoint_list(ref_obj_list)

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

Parameters:ref_obj_list – list of ServiceEndpoint 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_tag(ref_obj)

Set tag for virtual-machine-interface.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for virtual-machine-interface.

Parameters:ref_obj_list – list of Tag 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
set_virtual_port_group(ref_obj, ref_data=None)

Set virtual-port-group for virtual-machine-interface.

Parameters:
  • ref_obj – VirtualPortGroup object
  • ref_data – VMIVirtualPortGroupAttributes object
set_virtual_port_group_list(ref_obj_list, ref_data_list=None)

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

Parameters:
  • ref_obj_list – list of VirtualPortGroup object
  • ref_data_list – list of VMIVirtualPortGroupAttributes 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
vlan_tag_based_bridge_domain

Get vlan-tag-based-bridge-domain for virtual-machine-interface.

Returns:xsd:boolean object
vrf_assign_table

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

Returns:VrfAssignTableType object
class gen.resource_common.VirtualNetwork(name=None, parent_obj=None, ecmp_hashing_include_fields=None, virtual_network_category='tenant', virtual_network_properties=None, virtual_network_routed_properties=None, provider_properties=None, virtual_network_network_id=None, is_provider_network=False, port_security_enabled=True, fabric_snat=False, route_target_list=None, import_route_target_list=None, export_route_target_list=None, router_external=None, is_shared=None, mtu=None, external_ipam=None, flood_unknown_unicast=False, multi_policy_service_chains_enabled=None, address_allocation_mode=None, virtual_network_fat_flow_protocols=None, mac_learning_enabled=False, mac_limit_control=None, mac_move_control=None, mac_aging_time=300, pbb_evpn_enable=False, pbb_etree_enable=False, layer2_control_word=False, igmp_enable=False, mac_ip_learning_enable=False, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

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.

Created By:
User
Child of:
Project object
Properties:
  • ecmp_hashing_include_fields

    Type: EcmpHashingIncludeFields

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    ECMP hashing config at global level.

  • virtual_network_category

    Type: str, one-of [u’infra’, u’tenant’, u’internal’, u’routed’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This attribute is to differentiate the infrastructure networks from the tenant and routed networks.

    Infra-networks could be in-band network for management and control traffic

  • virtual_network_properties

    Type: VirtualNetworkType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Virtual network miscellaneous configurations.

  • virtual_network_routed_properties

    Type: VirtualNetworkRoutedPropertiesType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Attributes for routed virtual networks.

  • 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.

  • is_provider_network

    Type: bool

    Created By: User (optional)

    Operations Allowed: R

    Description:

    provider network status of the virtual-network.

  • port_security_enabled

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Port security status on the network

  • fabric_snat

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Provide connectivity to underlay network by port mapping

  • 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.

  • mtu

    Type: int, within [0, 9216]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    MTU attribute for the virtual network

  • 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 address 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: str, 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.

  • virtual_network_fat_flow_protocols

    Type: FatFlowProtocols

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Fat flow configuration which is a list, will be applied to all the interfaces in the specified

    virtual-network

  • mac_learning_enabled

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Enable MAC learning on the network

  • mac_limit_control

    Type: MACLimitControlType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    MAC limit control on the network

  • mac_move_control

    Type: MACMoveLimitControlType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    MAC move control on the network

  • mac_aging_time

    Type: int, within [0, 86400]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    MAC aging time on the network

  • pbb_evpn_enable

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Enable/Disable PBB EVPN tunneling on the network

  • pbb_etree_enable

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Enable/Disable PBB ETREE mode on the network

  • layer2_control_word

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Enable/Disable adding control word to the Layer 2 encapsulation

  • igmp_enable

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    IGMP mode at Global level.

  • mac_ip_learning_enable

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Enable/Disable MAC-IP Learning on the network

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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.

  • list of BridgeDomain objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    bridge-domains configured in a virtual network

References to:
  • list of SecurityLoggingObject objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to security logging object for this virtual network.

  • 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 to be used as

    property of the reference.

  • 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 VirtualNetwork objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to a virtual network which is the provider network for the given virtual network. Traffic

    forwarding happens in the routing instance of the provider network.

  • list of ServiceHealthCheck objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to health check object attached to VN object, used to enable BFD health check over MAC IP

    Learnt IP Addresses of VN.

  • list of RouteTable objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to route table attached to this virtual network.

  • list of MulticastPolicy objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to multicast policy. Each multicast policy has a list of (S,G) Addresses.

  • list of Bgpvpn objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Back reference to virtual network associated to the BGP VPN resource

  • list of IntentMap objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    All virtual-network objects that get created in the fabric

  • list of (RoutingPolicy object, RoutingPolicyType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of references of routing policy objects. imported by user.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_bgpvpn(ref_obj)

Add bgpvpn to virtual-network.

Parameters:ref_obj – Bgpvpn object
add_intent_map(ref_obj)

Add intent-map to virtual-network.

Parameters:ref_obj – IntentMap object
add_multicast_policy(ref_obj)

Add multicast-policy to virtual-network.

Parameters:ref_obj – MulticastPolicy object
add_network_ipam(ref_obj, ref_data=None)

Add network-ipam to virtual-network.

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

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
add_routing_policy(ref_obj, ref_data=None)

Add routing-policy to virtual-network.

Parameters:
  • ref_obj – RoutingPolicy object
  • ref_data – RoutingPolicyType object
add_security_logging_object(ref_obj)

Add security-logging-object to virtual-network.

Parameters:ref_obj – SecurityLoggingObject object
add_service_health_check(ref_obj)

Add service-health-check to virtual-network.

Parameters:ref_obj – ServiceHealthCheck object
add_tag(ref_obj)

Add tag to virtual-network.

Parameters:ref_obj – Tag object
add_virtual_network(ref_obj)

Add virtual-network to virtual-network.

Parameters:ref_obj – VirtualNetwork object
address_allocation_mode

Get address-allocation-mode for virtual-network.

Returns:AddressAllocationModeType object
annotations

Get annotations for virtual-network.

Returns:KeyValuePairs 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
fabric_snat

Get fabric-snat for virtual-network.

Returns:xsd:boolean object
flood_unknown_unicast

Get flood-unknown-unicast for virtual-network.

Returns:xsd:boolean object
get_bgpvpn_refs()

Return bgpvpn list for virtual-network.

Returns:list of <Bgpvpn>
get_data_center_interconnect_back_refs()

Return list of all data-center-interconnects using this virtual-network

get_fabric_back_refs()

Return list of all fabrics using this virtual-network

get_firewall_rule_back_refs()

Return list of all firewall-rules using this virtual-network

get_flow_node_back_refs()

Return list of all flow-nodes using this virtual-network

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_host_based_service_back_refs()

Return list of all host-based-services using this virtual-network

get_instance_ip_back_refs()

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

get_intent_map_refs()

Return intent-map list for virtual-network.

Returns:list of <IntentMap>
get_logical_router_back_refs()

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

get_multicast_policy_refs()

Return multicast-policy list for virtual-network.

Returns:list of <MulticastPolicy>
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_port_tuple_back_refs()

Return list of all port-tuples 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_routing_policy_refs()

Return routing-policy list for virtual-network.

Returns:list of tuple <RoutingPolicy, RoutingPolicyType>
get_security_logging_object_refs()

Return security-logging-object list for virtual-network.

Returns:list of <SecurityLoggingObject>
get_service_health_check_refs()

Return service-health-check list for virtual-network.

Returns:list of <ServiceHealthCheck>
get_tag_refs()

Return tag list for virtual-network.

Returns:list of <Tag>
get_type()

Return object type (virtual-network).

get_virtual_machine_interface_back_refs()

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

get_virtual_network_back_refs()

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

get_virtual_network_refs()

Return virtual-network list for virtual-network.

Returns:list of <VirtualNetwork>
id_perms

Get id-perms for virtual-network.

Returns:IdPermsType object
igmp_enable

Get igmp-enable for virtual-network.

Returns:xsd:boolean object
import_route_target_list

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

Returns:RouteTargetList object
is_provider_network

Get is-provider-network for virtual-network.

Returns:xsd:boolean object
is_shared

Get is-shared for virtual-network.

Returns:xsd:boolean object
layer2_control_word

Get layer2-control-word for virtual-network.

Returns:xsd:boolean object
mac_aging_time

Get mac-aging-time for virtual-network.

Returns:MACAgingTime object
mac_ip_learning_enable

Get mac-ip-learning-enable for virtual-network.

Returns:xsd:boolean object
mac_learning_enabled

Get mac-learning-enabled for virtual-network.

Returns:xsd:boolean object
mac_limit_control

Get mac-limit-control for virtual-network.

Returns:MACLimitControlType object
mac_move_control

Get mac-move-control for virtual-network.

Returns:MACMoveLimitControlType object
mtu

Get mtu for virtual-network.

Returns:NetworkMtuType object
multi_policy_service_chains_enabled

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

Returns:xsd:boolean object
pbb_etree_enable

Get pbb-etree-enable for virtual-network.

Returns:xsd:boolean object
pbb_evpn_enable

Get pbb-evpn-enable for virtual-network.

Returns:xsd:boolean object
perms2

Get perms2 for virtual-network.

Returns:PermType2 object
port_security_enabled

Get port-security-enabled for virtual-network.

Returns:xsd:boolean 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_bgpvpn(ref_obj)

Set bgpvpn for virtual-network.

Parameters:ref_obj – Bgpvpn object
set_bgpvpn_list(ref_obj_list)

Set bgpvpn list for virtual-network.

Parameters:ref_obj_list – list of Bgpvpn object
set_intent_map(ref_obj)

Set intent-map for virtual-network.

Parameters:ref_obj – IntentMap object
set_intent_map_list(ref_obj_list)

Set intent-map list for virtual-network.

Parameters:ref_obj_list – list of IntentMap object
set_multicast_policy(ref_obj)

Set multicast-policy for virtual-network.

Parameters:ref_obj – MulticastPolicy object
set_multicast_policy_list(ref_obj_list)

Set multicast-policy list for virtual-network.

Parameters:ref_obj_list – list of MulticastPolicy object
set_network_ipam(ref_obj, ref_data=None)

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=None)

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=None)

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=None)

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
set_routing_policy(ref_obj, ref_data=None)

Set routing-policy for virtual-network.

Parameters:
  • ref_obj – RoutingPolicy object
  • ref_data – RoutingPolicyType object
set_routing_policy_list(ref_obj_list, ref_data_list=None)

Set routing-policy list for virtual-network.

Parameters:
  • ref_obj_list – list of RoutingPolicy object
  • ref_data_list – list of RoutingPolicyType object
set_security_logging_object(ref_obj)

Set security-logging-object for virtual-network.

Parameters:ref_obj – SecurityLoggingObject object
set_security_logging_object_list(ref_obj_list)

Set security-logging-object list for virtual-network.

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

Set service-health-check for virtual-network.

Parameters:ref_obj – ServiceHealthCheck object
set_service_health_check_list(ref_obj_list)

Set service-health-check list for virtual-network.

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

Set tag for virtual-network.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for virtual-network.

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

Set virtual-network for virtual-network.

Parameters:ref_obj – VirtualNetwork object
set_virtual_network_list(ref_obj_list)

Set virtual-network list for virtual-network.

Parameters:ref_obj_list – list of VirtualNetwork object
virtual_network_category

Get virtual-network-category for virtual-network.

Returns:VirtualNetworkCategory object
virtual_network_fat_flow_protocols

Get virtual-network-fat-flow-protocols for virtual-network.

Returns:FatFlowProtocols 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
virtual_network_routed_properties

Get virtual-network-routed-properties for virtual-network.

Returns:VirtualNetworkRoutedPropertiesType object
class gen.resource_common.VirtualPortGroup(name=None, parent_obj=None, virtual_port_group_lacp_enabled=None, virtual_port_group_trunk_port_id=None, virtual_port_group_user_created=True, virtual_port_group_type='access', id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

When parent is fabric:
List of virtual port groups in this fabric.
When parent is project:
List of virtual port groups/trunk ports in this project.
Created By:
User when parent is Fabric User when parent is Project
Child of:
Fabric object OR Project object
Properties:
  • virtual_port_group_lacp_enabled

    Type: bool

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Flag to turn on or off Link Aggregation Control Protocol (LACP) on this link aggregation group.

  • virtual_port_group_trunk_port_id

    Type: str

    Created By: User (required)

    Operations Allowed: CR

    Description:

    id of the port that enables multi valn trunking.

  • virtual_port_group_user_created

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Flag to be set to True when its externally created and False when created internally. Default is set

    to True

  • virtual_port_group_type

    Type: str, one-of [u’access’, u’routed’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Type of Virtual port group. It can be either access i.e L2 connectivity or routed.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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, VpgInterfaceParametersType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    All the physical interfaces that belong to this link aggregation group. The physical interface could

    belong to the same or different physical router

  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    list of virtual machine interfaces that are part of this virtual port group

  • 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 virtual

    port group.

  • list of PortProfile objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Port profiles attached to this virtual port group

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_physical_interface(ref_obj, ref_data=None)

Add physical-interface to virtual-port-group.

Parameters:
  • ref_obj – PhysicalInterface object
  • ref_data – VpgInterfaceParametersType object
add_port_profile(ref_obj)

Add port-profile to virtual-port-group.

Parameters:ref_obj – PortProfile object
add_security_group(ref_obj)

Add security-group to virtual-port-group.

Parameters:ref_obj – SecurityGroup object
add_tag(ref_obj)

Add tag to virtual-port-group.

Parameters:ref_obj – Tag object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to virtual-port-group.

Parameters:ref_obj – VirtualMachineInterface object
annotations

Get annotations for virtual-port-group.

Returns:KeyValuePairs object
display_name

Get display-name for virtual-port-group.

Returns:xsd:string object
dump()

Display virtual-port-group object in compact form.

get_fq_name()

Return FQN of virtual-port-group in list form.

get_fq_name_str()

Return FQN of virtual-port-group as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_physical_interface_refs()

Return physical-interface list for virtual-port-group.

Returns:list of tuple <PhysicalInterface, VpgInterfaceParametersType>
get_port_profile_refs()

Return port-profile list for virtual-port-group.

Returns:list of <PortProfile>
get_security_group_refs()

Return security-group list for virtual-port-group.

Returns:list of <SecurityGroup>
get_tag_refs()

Return tag list for virtual-port-group.

Returns:list of <Tag>
get_type()

Return object type (virtual-port-group).

get_virtual_machine_interface_back_refs()

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

get_virtual_machine_interface_refs()

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

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for virtual-port-group.

Returns:IdPermsType object
perms2

Get perms2 for virtual-port-group.

Returns:PermType2 object
set_physical_interface(ref_obj, ref_data=None)

Set physical-interface for virtual-port-group.

Parameters:
  • ref_obj – PhysicalInterface object
  • ref_data – VpgInterfaceParametersType object
set_physical_interface_list(ref_obj_list, ref_data_list=None)

Set physical-interface list for virtual-port-group.

Parameters:
  • ref_obj_list – list of PhysicalInterface object
  • ref_data_list – list of VpgInterfaceParametersType object
set_port_profile(ref_obj)

Set port-profile for virtual-port-group.

Parameters:ref_obj – PortProfile object
set_port_profile_list(ref_obj_list)

Set port-profile list for virtual-port-group.

Parameters:ref_obj_list – list of PortProfile object
set_security_group(ref_obj)

Set security-group for virtual-port-group.

Parameters:ref_obj – SecurityGroup object
set_security_group_list(ref_obj_list)

Set security-group list for virtual-port-group.

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

Set tag for virtual-port-group.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for virtual-port-group.

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

Set virtual-machine-interface for virtual-port-group.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

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

Parameters:ref_obj_list – list of VirtualMachineInterface object
virtual_port_group_lacp_enabled

Get virtual-port-group-lacp-enabled for virtual-port-group.

Returns:xsd:boolean object
virtual_port_group_trunk_port_id

Get virtual-port-group-trunk-port-id for virtual-port-group.

Returns:xsd:string object
virtual_port_group_type

Get virtual-port-group-type for virtual-port-group.

Returns:VpgType object
virtual_port_group_user_created

Get virtual-port-group-user-created for virtual-port-group.

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

Bases: future.types.newobject.newobject

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

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • virtual_router_type

    Type: str, 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 library, Virtual machines interfaces scheduled on this

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

    driver. It is only applicable for embedded vrouter.

  • virtual_router_sriov_physical_networks

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of (physnet, interface) mapping for this virtual router.

  • virtual_router_ip_address

    Type: str, 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: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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:

    An interface on a virtual-router, e.g. vhost0

References to:
  • list of (NetworkIpam object, VirtualRouterNetworkIpamType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to network-ipam this virtual-router is using. It has list of virtual-router specific

    allocation-pools and cidrs that are to be used as property of the reference.

  • list of SubCluster objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference of vrouter to sub-cluster.

  • 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.

  • list of Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:
add_network_ipam(ref_obj, ref_data=None)

Add network-ipam to virtual-router.

Parameters:
  • ref_obj – NetworkIpam object
  • ref_data – VirtualRouterNetworkIpamType object
add_sub_cluster(ref_obj)

Add sub-cluster to virtual-router.

Parameters:ref_obj – SubCluster object
add_tag(ref_obj)

Add tag to virtual-router.

Parameters:ref_obj – Tag object
add_virtual_machine(ref_obj)

Add virtual-machine to virtual-router.

Parameters:ref_obj – VirtualMachine object
annotations

Get annotations for virtual-router.

Returns:KeyValuePairs 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_instance_ip_back_refs()

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

get_network_ipam_refs()

Return network-ipam list for virtual-router.

Returns:list of tuple <NetworkIpam, VirtualRouterNetworkIpamType>
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_sub_cluster_refs()

Return sub-cluster list for virtual-router.

Returns:list of <SubCluster>
get_tag_refs()

Return tag list for virtual-router.

Returns:list of <Tag>
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_network_ipam(ref_obj, ref_data=None)

Set network-ipam for virtual-router.

Parameters:
  • ref_obj – NetworkIpam object
  • ref_data – VirtualRouterNetworkIpamType object
set_network_ipam_list(ref_obj_list, ref_data_list=None)

Set network-ipam list for virtual-router.

Parameters:
  • ref_obj_list – list of NetworkIpam object
  • ref_data_list – list of VirtualRouterNetworkIpamType object
set_sub_cluster(ref_obj)

Set sub-cluster for virtual-router.

Parameters:ref_obj – SubCluster object
set_sub_cluster_list(ref_obj_list)

Set sub-cluster list for virtual-router.

Parameters:ref_obj_list – list of SubCluster object
set_tag(ref_obj)

Set tag for virtual-router.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for virtual-router.

Parameters:ref_obj_list – list of Tag 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_sriov_physical_networks

Get virtual-router-sriov-physical-networks for virtual-router.

Returns:KeyValuePairs object
virtual_router_type

Get virtual-router-type for virtual-router.

Returns:VirtualRouterType object
class gen.resource_common.WebuiNode(name=None, parent_obj=None, webui_node_ip_address=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: future.types.newobject.newobject

WebUI node is object representing a logical node in system which hosts the Contrail UI.

Created By:
User
Child of:
GlobalSystemConfig object
Properties:
  • webui_node_ip_address

    Type: str, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Ip address of the webui node, set while provisioning.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: RU

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • annotations

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Dictionary of arbitrary (key, value) on a resource.

  • display_name

    Type: str

    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 Tag objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Tag attached to an object - has a type and value

Referred by:

add_tag(ref_obj)

Add tag to webui-node.

Parameters:ref_obj – Tag object
annotations

Get annotations for webui-node.

Returns:KeyValuePairs object
display_name

Get display-name for webui-node.

Returns:xsd:string object
dump()

Display webui-node object in compact form.

get_fq_name()

Return FQN of webui-node in list form.

get_fq_name_str()

Return FQN of webui-node as colon delimited string.

get_parent_fq_name()

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

get_parent_fq_name_str()

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

get_tag_refs()

Return tag list for webui-node.

Returns:list of <Tag>
get_type()

Return object type (webui-node).

id_perms

Get id-perms for webui-node.

Returns:IdPermsType object
perms2

Get perms2 for webui-node.

Returns:PermType2 object
set_tag(ref_obj)

Set tag for webui-node.

Parameters:ref_obj – Tag object
set_tag_list(ref_obj_list)

Set tag list for webui-node.

Parameters:ref_obj_list – list of Tag object
webui_node_ip_address

Get webui-node-ip-address for webui-node.

Returns:IpAddressType object

resource_xsd Module

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

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * 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 gen.resource_xsd.AclRuleType(match_condition=None, action_list=None, rule_uuid=None, direction=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * 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: str

    Created By: User (optional)

    Description:

    Rule UUID is identifier used in flow records to identify rule

  • direction

    Type: str, one-of [u’>’, u’<>’]

    Created By: User (optional)

    Description:

    Direction in the rule

class gen.resource_xsd.ActionAsPathType(expand=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * expand

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * add

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * add

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * simple_action

Type: str, 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: str

    Created By: User (optional)

    Description:

    For internal use only

  • apply_service

    Type: str

    Created By: User (optional)

    Description:

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

    the rule

  • service_properties

    Type: ServicePropertiesType

    Created By: User (optional)

    Description:

    Properties of the service-policy if action is apply-service

  • mirror_to

    Type: MirrorActionType

    Created By: User (optional)

    Description:

    Mirror traffic matching this rule

  • assign_routing_instance

    Type: str

    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: str

    Created By: User (optional)

    Description:

    FQN of Qos configuration object for QoS marking

  • host_based_service

    Type: bool

    Description:

    Forward traffic matching this rule to the project’s host based service

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * as_path

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * family

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

Description:
BGP address families supported by contrail.
class gen.resource_xsd.AddressType(subnet=None, virtual_network=None, security_group=None, network_policy=None, subnet_list=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * subnet

Type: SubnetType

Created By: User (optional)

Description:
Any address that belongs to this subnet
  • virtual_network

    Type: str

    Created By: User (optional)

    Description:

    Any address that belongs to this virtual network

  • security_group

    Type: str

    Created By: User (optional)

    Description:

    Any address that belongs to interface with this security-group

  • network_policy

    Type: str

    Created By: User (optional)

    Description:

    Any address that belongs to virtual network which has this policy attached

  • subnet_list

    Type: SubnetType

    Created By: User (optional)

    Description:

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

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * and_list

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * operation

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

Created By: User (required)

Description:
operation to compare operand1 and operand2
  • operand1

    Type: str

    Created By: User (required)

    Description:

    UVE attribute specified in the dotted format. Example:

    NodeStatus.process_info.process_state

  • operand2

    Type: AlarmOperand2

    Created By: User (required)

    Description:

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

  • variables

    Type: str

    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

    variables

class gen.resource_xsd.AlarmOperand2(uve_attribute=None, json_value=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * uve_attribute

Type: str

Created By: User (optional)

Description:

UVE attribute specified in the dotted format. Example:

NodeStatus.process_info.process_state

  • json_value

    Type: str

    Created By: User (optional)

    Description:

    json value as string

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * or_list

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * start

Type: str
  • end

    Type: str

  • vrouter_specific_pool

    Type: bool

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ip

  • mac

    Type: str

    Created By: User (optional)

  • address_mode

    Type: str, 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 gen.resource_xsd.AllowedAddressPairs(allowed_address_pair=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * allowed_address_pair

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * api_access

Type: ApiAccessType

Created By: User (required)

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * api_name

Type: str

Created By: User (required)

  • permissions

    Type: PermType

    Created By: User (required)

class gen.resource_xsd.AsListType(asn_list=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * asn_list

Type: int
class gen.resource_xsd.AsnRangeType(asn_min=None, asn_max=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * asn_min

Type: int
  • asn_max

    Type: int

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes:

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * static

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * key_type

Type: str, 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 gen.resource_xsd.AuthenticationKeyItem(key_id=None, key=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * key_id

Type: int, within [0, 63]
  • key

    Type: str

class gen.resource_xsd.AutonomousSystemsType(asn=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * asn

Type: int, within [1, 4294967295]
class gen.resource_xsd.BGPaaSControlNodeZoneAttributes(bgpaas_control_node_zone_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * bgpaas_control_node_zone_type

Type: str, one-of [u’primary’, u’secondary’]

Created By: User (optional)

Description:

Specifies BGPaaSControlNodeZoneType. If bgpaas uses x.x.x.1 ip for

peering, BGPaaSControlNodeZoneType should be set to primary. If it

is x.x.x.2 ip for peering, BGPaaSControlNodeZoneType should be

secondary

class gen.resource_xsd.BGPaaServiceParametersType(port_start=50000, port_end=50512, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * port_start

Type: int, within [-1, 65535]
  • port_end

    Type: int, within [-1, 65535]

class gen.resource_xsd.BaremetalPortGroupInfo(standalone_ports_supported=None, node_uuid=None, properties=None, address=None, mode=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * standalone_ports_supported

Type: bool

Description:

Indicates whether ports that are members of this portgroup can be used as stand-

alone ports.

  • node_uuid

    Type: str

    Description:

    UUID of the parent node where this port is connected

  • properties

    Type: PortGroupProperties

    Description:

    Key/value properties related to the port group’s configuration.

  • address

    Type: str

    Description:

    Mac Address of the NIC in Node

  • mode

    Type: str

    Description:

    Mode of the port group

class gen.resource_xsd.BaremetalPortInfo(pxe_enabled=None, local_link_connection=None, node_uuid=None, address=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * pxe_enabled

Type: bool

Description:
Indicates whether PXE is enabled or disabled on the Port.
  • local_link_connection

    Type: LocalLinkConnection

    Description:

    The Port binding profile

  • node_uuid

    Type: str

    Description:

    UUID of the parent node where this port is connected

  • address

    Type: str

    Description:

    Mac Address of the NIC in Node

class gen.resource_xsd.BaremetalProperties(memory_mb=None, cpu_arch=None, local_gb=None, cpus=None, capabilities=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * memory_mb

Type: int

Description:
RAM of the Baremetal server (in MB)
  • cpu_arch

    Type: str

    Description:

    Architecture of the baremetal server

  • local_gb

    Type: int

    Description:

    Disk size of root device (in GB)

  • cpus

    Type: int

    Description:

    Number of CPU cores on the baremetal

  • capabilities

    Type: str

    Description:

    Boot option

class gen.resource_xsd.BaremetalServerInfo(network_interface=None, driver=None, properties=None, driver_info=None, name=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * network_interface

Type: str

Description:
Networking interface
  • driver

    Type: str

    Description:

    IPMI driver

  • properties

    Type: BaremetalProperties

    Description:

    Details of baremetal hardware for scheduler

  • driver_info

    Type: DriverInfo

    Description:

    Details of the driver for power management

  • name

    Type: str

    Description:

    Name of the Baremetal server

class gen.resource_xsd.BfdParameters(time_interval=None, detection_time_multiplier=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * time_interval

Type: int

Created By: User (optional)

Description:
Rx/Tx time interval for BFD session in milliseconds.
  • detection_time_multiplier

    Type: int

    Created By: User (optional)

    Description:

    Detection time multiplier for BFD session.

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * address_family

Type: str, one-of [u’inet’, u’inet-labeled’, u’inet-vpn’, u’e-vpn’, u’erm-vpn’, u’route-target’, u’inet6’, u’inet-mvpn’, 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.

  • default_tunnel_encap

    Type: str, one-of [u’gre’, u’mpls’, u’udp’, u’vxlan’]

    Created By: User (optional)

    Description:

    Default prioritized tunnel encapsulation list.

class gen.resource_xsd.BgpParameters(peer_autonomous_system=None, peer_ip_address=None, peer_ip_address_list=None, hold_time=0, auth_data=None, local_autonomous_system=None, multihop_ttl=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * peer_autonomous_system

Type: int

Created By: User (required)

Description:
Peer autonomous system number for this eBGP session.
  • peer_ip_address

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    Peer ip address used for this eBGP session.

  • peer_ip_address_list

    Type: str, one-of xsd:string

    Created By: User (required)

    Description:

    Peer ip address list used for this eBGP session.

  • 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

  • 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:

    BgpRouter specific Autonomous System number if different from global AS number.

  • multihop_ttl

    Type: int

    Created By: User (optional)

    Description:

    time-to-live (TTL) value in the BGP packets to control how far they propagate.

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * session

Type: BgpSession

Created By: User (required)

Description:

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

BGP routers. Currently only 1 session is supported.

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * maximum

Type: int
  • idle_timeout

    Type: int, within [0, 86400]

    Created By: User (optional)

    Description:

    Time in seconds after which the session is allowed to re-establish after

    teardown.

class gen.resource_xsd.BgpRouterParams(admin_down=False, vendor=None, cluster_id=None, autonomous_system=None, identifier=None, address=None, port=179, 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: gen.generatedssuper.GeneratedsSuper

Attributes: * admin_down

Type: bool

Created By: User (optional)

Description:
Administratively up or down.
  • vendor

    Type: str

    Created By: User (optional)

    Description:

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

  • cluster_id

    Type: int

    Created By: User (optional)

    Description:

    Cluster Id for this BGP router.

  • autonomous_system

    Type: int

    Created By: User (required)

    Description:

    Autonomous 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: str, 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: str, one-of xsd:string

    Created By: User (required)

    Description:

    Ip address 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:

    BgpRouter specific Autonomous System number if different from global AS number.

    Typically used when clusters of control nodes in same contrail system are in

    different locations. Currently only 16 bit AS number is supported.

  • router_type

    Type: str, 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: str, 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: str, one-of xsd:string

    Created By: User (optional)

    Description:

    The ipv6-gateway-address 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 gen.resource_xsd.BgpSession(uuid=None, attributes=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * uuid

Type: str

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 gen.resource_xsd.BgpSessionAttributes(bgp_router=None, admin_down=False, passive=False, as_override=False, hold_time=0, loop_count=0, local_autonomous_system=0, address_families=None, auth_data=None, family_attributes=None, private_as_action=None, route_origin_override=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * bgp_router

Type: str

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 relevant

    when session attributes represent common part. It is recommended 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 AS is

    allowed in the AS_PATH attribute.

  • local_autonomous_system

    Type: int

    Created By: User (optional)

    Description:

    Local autonomous system number used for this particular session. If configured,

    this overrides autonomous-system number and local-autonomous-system number

    configured under BgpRouterParams

  • 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.

  • private_as_action

    Type: str, one-of [u’remove’, u’remove-all’, u’replace-all’]

    Created By: User (optional)

    Description:

    Remove or replace private ASes from AS Path attributes advertised to this

    session.

  • route_origin_override

    Type: RouteOriginOverride

    Created By: User (optional)

    Description:

    User defined route origin value to override

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes:

class gen.resource_xsd.BridgeDomainMembershipType(vlan_tag=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * vlan_tag

Type: int, within [0, 4094]

Description:

VLAN tag of the incoming packet that maps the virtual-

machine-interface to bridge domain

class gen.resource_xsd.CliDiffInfoType(username=None, time=None, config_changes=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * username

Type: str
  • time

    Type: str

  • config_changes

    Type: str

class gen.resource_xsd.CliDiffListType(commit_diff_info=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * commit_diff_info

class gen.resource_xsd.CloudInstanceInfo(os_version=None, operating_system=None, roles=None, availability_zone=None, instance_type=None, machine_id=None, volume_size=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * os_version

Type: str

Description:
specific version of operating system
  • operating_system

    Type: str

    Description:

    Name of operating system, ex - centos7 or ubuntu16

  • roles

    Type: None

    Description:

    Roles of the cloud instance

  • availability_zone

    Type: str

    Description:

    Availability zone to which the instance belongs to

  • instance_type

    Type: str

    Description:

    size of instance

  • machine_id

    Type: str

    Description:

    image (ami) id of instance

  • volume_size

    Type: int

    Description:

    Size of the volume for the cloud instance

class gen.resource_xsd.CommunityAttributes(community_attribute=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * community_attribute

Type: str, 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 gen.resource_xsd.CommunityListType(community=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * community

Type: str, 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 gen.resource_xsd.ConnectionType(destination_instance=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * destination_instance

Type: str
class gen.resource_xsd.ControlTrafficDscpType(control=None, analytics=None, dns=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * control

Type: int, within [0, 63]

Created By: User (optional)

Description:
DSCP value for control protocols traffic
  • analytics

    Type: int, within [0, 63]

    Created By: User (optional)

    Description:

    DSCP value for traffic towards analytics

  • dns

    Type: int, within [0, 63]

    Created By: User (optional)

    Description:

    DSCP value for DNS traffic

class gen.resource_xsd.DefaultProtocolType(bgp=None, ospf=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * bgp

class gen.resource_xsd.DeviceCredential(credential=None, vendor=None, device_family=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * credential

Type: UserCredentials

Created By: User (required)

  • vendor

    Type: str

    Created By: User (optional)

  • device_family

    Type: str

    Created By: User (optional)

class gen.resource_xsd.DeviceCredentialList(device_credential=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * device_credential

class gen.resource_xsd.DeviceFamilyListType(device_family=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * device_family

Type: str
class gen.resource_xsd.DevicePlatformListType(platform_name=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * platform_name

Type: str
class gen.resource_xsd.DhcpOptionType(dhcp_option_name=None, dhcp_option_value=None, dhcp_option_value_bytes=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * dhcp_option_name

Type: str

Created By: User (required)

Description:
Name of the DHCP option
  • dhcp_option_value

    Type: str

    Created By: User (required)

    Description:

    Encoded DHCP option value (decimal)

  • dhcp_option_value_bytes

    Type: str

    Created By: User (required)

    Description:

    Value of the DHCP option to be copied byte by byte

class gen.resource_xsd.DhcpOptionsListType(dhcp_option=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * dhcp_option

Type: DhcpOptionType

Description:
List of DHCP options
class gen.resource_xsd.DiscoveryPubSubEndPointType(ep_type=None, ep_id=None, ep_prefix=None, ep_version=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ep_type

Type: str

Created By: User (required)

Description:
Type of service or client
  • ep_id

    Type: str

    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: str

    Created By: User (optional)

    Description:

    All servers or clients whose version match this version

class gen.resource_xsd.DiscoveryServiceAssignmentType(publisher=None, subscriber=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * publisher

Type: DiscoveryPubSubEndPointType

Created By: User (required)

Description:
Publisher set
class gen.resource_xsd.DnsSoaRecordType(negative_cache_ttl_seconds=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * negative_cache_ttl_seconds

Type: int

Created By: User (optional)

Description:
Default Time To Live for negative caching of DNS queries
class gen.resource_xsd.DnsmasqLeaseParameters(lease_expiry_time=None, client_id=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * lease_expiry_time

Type: int
  • client_id

    Type: str

class gen.resource_xsd.DomainLimitsType(project_limit=None, virtual_network_limit=None, security_group_limit=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * project_limit

Type: int

Created By: User (optional)

Description:
Maximum number of projects allowed in this domain
  • virtual_network_limit

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of virtual networks allowed in this domain

  • security_group_limit

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of security groups allowed in this domain

class gen.resource_xsd.DpdkInfo(cpu_core_mask=None, dpdk_uio_driver=None, huge_pages=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * cpu_core_mask

Type: str

Description:
CPU Core Mask
  • dpdk_uio_driver

    Type: str

    Description:

    UIO Driver

  • huge_pages

    Type: int

    Description:

    Hugepages Size

class gen.resource_xsd.DriverInfo(ipmi_address=None, deploy_ramdisk=None, ipmi_password=None, ipmi_port=None, ipmi_username=None, deploy_kernel=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ipmi_address

Type: str

Description:
IPMI address of the server to manage boot device and power management
  • deploy_ramdisk

    Type: str

    Description:

    UUID of the deploy initrd/ramdisk

  • ipmi_password

    Type: str

    Description:

    Password to access IPMI

  • ipmi_port

    Type: str

    Description:

    Remote IPMI RMCP port

  • ipmi_username

    Type: str

    Description:

    Username to access IPMI

  • deploy_kernel

    Type: str

    Description:

    UUID of the deploy kernel

class gen.resource_xsd.ESXIHostInfo(username=None, datacenter=None, esxi_name=None, cluster=None, mac=None, datastore=None, password=None, vcenter_server=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * username

Type: str

Description:
username
  • datacenter

    Type: str

    Description:

    datacenter in vCenter

  • esxi_name

    Type: str

    Description:

    ESXI host name(ip)

  • cluster

    Type: str

    Description:

    cluster in vCenter

  • mac

    Type: str

    Description:

    mac address for contrailvm

  • datastore

    Type: str

    Description:

    datastore in vCenter

  • password

    Type: str

    Description:

    ESXI host password

  • vcenter_server

    Type: str

    Description:

    vCenter server

class gen.resource_xsd.ESXIProperties(dvs_name=None, dvs_id=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * dvs_name

Type: str

Description:
Name of the Distributed Virtual Switch(DVS) assigned to Port.
  • dvs_id

    Type: str

    Description:

    MOid of the Distributed Virtual Switch(DVS) assigned to Port.

class 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: gen.generatedssuper.GeneratedsSuper

Attributes: * 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 gen.resource_xsd.EnabledInterfaceParams(name=None, stats_collection_frequency=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * name

Type: str
class gen.resource_xsd.EnabledSensorParams(physical_health=True, interface_health=True, control_plane_health=True, service_layer_health=True, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * physical_health

Type: bool
  • interface_health

    Type: bool

  • control_plane_health

    Type: bool

  • service_layer_health

    Type: bool

class gen.resource_xsd.EncapsulationPrioritiesType(encapsulation=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * encapsulation

Type: str, one-of [u’MPLSoGRE’, u’MPLSoUDP’, u’VXLAN’]

Created By: User (optional)

Description:
Ordered list of encapsulation types to be used in priority
class gen.resource_xsd.EncryptionTunnelEndpoint(tunnel_remote_ip_address=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * tunnel_remote_ip_address

Type: str, one-of xsd:string

Created By: User (required)

Description:
Tunnel endpoint remote address
class gen.resource_xsd.EncryptionTunnelEndpointList(endpoint=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * endpoint

Type: EncryptionTunnelEndpoint

Description:
Tunnel endpoint remote address
class gen.resource_xsd.ExecutableInfoListType(executable_info=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * executable_info

class gen.resource_xsd.ExecutableInfoType(executable_path=None, executable_args=None, job_completion_weightage=100, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * executable_path

Type: str

Created By: User (required)

Description:
absolute path of the binary to execute
  • executable_args

    Type: str

    Created By: User (optional)

    Description:

    Optional arguments to be passed to the executable

  • job_completion_weightage

    Type: int

    Description:

    Job percentage completion when this executable is completed.

class gen.resource_xsd.ExtCommunityListType(community=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * community

Type: str
class gen.resource_xsd.FabricNetworkTag(network_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * network_type

Type: str, one-of [u’management’, u’loopback’, u’ip-fabric’, u’pnf-servicechain’, u’overlay-loopback’]
class gen.resource_xsd.FastConvergenceParametersType(enable=False, nh_reachability_check=False, xmpp_hold_time=90, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * enable

Type: bool

Description:
Enable/Disable knob for all Fast-Convergence parameters to take effect
  • nh_reachability_check

    Type: bool

    Description:

    Enable next-hop reachability checks in control plane for routes in underlay for

    faster convergence

  • xmpp_hold_time

    Type: int, within [1, 90]

    Description:

    The negotiated XMPP hold-time (in seconds) for sessions between the control and

    data plane

class gen.resource_xsd.FatFlowProtocols(fat_flow_protocol=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * fat_flow_protocol

class gen.resource_xsd.FieldNamesList(field_names=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * field_names

Type: str
class gen.resource_xsd.FirewallRuleEndpointType(subnet=None, virtual_network=None, address_group=None, tags=None, tag_ids=None, any=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * subnet

Type: SubnetType

Created By: User (optional)

Description:
Any workload that belongs to this subnet
  • virtual_network

    Type: str

    Created By: User (optional)

    Description:

    Any workload that belongs to this virtual network

  • address_group

    Type: str

    Created By: User (optional)

    Description:

    Any workload with interface in this address-group

  • tags

    Type: str

    Created By: User (optional)

    Description:

    Any workload with tags matching tags in this list

  • tag_ids

    Type: int

    Description:

    Any workload with tags ids matching all the tags ids in this list

  • any

    Type: bool

    Created By: User (optional)

    Description:

    Match any workload

class gen.resource_xsd.FirewallRuleMatchTagsType(tag_list=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * tag_list

Type: TagType

Created By: User (required)

class gen.resource_xsd.FirewallRuleMatchTagsTypeIdList(tag_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * tag_type

Type: int

Created By: User (required)

class gen.resource_xsd.FirewallSequence(sequence=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * sequence

Type: str, one-of xsd:string

Created By: User (required)

class gen.resource_xsd.FirewallServiceGroupType(firewall_service=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * firewall_service

Type: FirewallServiceType

Created By: User (required)

class gen.resource_xsd.FirewallServiceType(protocol=None, protocol_id=None, src_ports=None, dst_ports=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str

Description:
Layer 4 protocol in ip packet
  • protocol_id

    Type: int

    Description:

    Layer 4 protocol id in ip packet

  • src_ports

    Type: PortType

    Description:

    Range of source port for layer 4 protocol

  • dst_ports

    Type: PortType

    Description:

    Range of destination port for layer 4 protocol

class gen.resource_xsd.FloatingIpPoolSubnetType(subnet_uuid=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * subnet_uuid

Type: str

Description:
List of subnets associated with this floating ip pool.
class gen.resource_xsd.FlowAgingTimeout(protocol=None, port=None, timeout_in_seconds=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str
  • port

    Type: int

  • timeout_in_seconds

    Type: int

class gen.resource_xsd.FlowAgingTimeoutList(flow_aging_timeout=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * flow_aging_timeout

Type: FlowAgingTimeout

Created By: User (optional)

Description:
List of (ip protocol, port number, timeout in seconds)
class gen.resource_xsd.GracefulRestartParametersType(enable=False, restart_time=300, long_lived_restart_time=300, end_of_rib_timeout=300, bgp_helper_enable=False, xmpp_helper_enable=False, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * enable

Type: bool

Description:
Enable/Disable knob for all GR parameters to take effect
  • restart_time

    Type: int, within [0, 4095]

    Description:

    Time (in seconds) taken by the restarting speaker to get back to stable state

  • long_lived_restart_time

    Type: int, within [0, 16777215]

    Description:

    Extended Time (in seconds) taken by the restarting speaker after restart-time to

    get back to stable state

  • end_of_rib_timeout

    Type: int, within [0, 4095]

    Description:

    Maximum time (in seconds) to wait for EndOfRib reception/transmission

  • bgp_helper_enable

    Type: bool

    Description:

    Enable GR Helper mode for BGP peers in contrail-control

  • xmpp_helper_enable

    Type: bool

    Description:

    Enable GR Helper mode for XMPP peers (agents) in contrail-control

class gen.resource_xsd.GrpcParameters(allow_clients=None, enabled_sensor_params=None, secure_mode=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * allow_clients

Type: SubnetListType

Created By: User (required)

Description:
whitelist subnet of allowed clients on which various KPIs can be monitored.
  • enabled_sensor_params

    Type: EnabledSensorParams

    Description:

    List of different top level sensor params that the user wishes to monitor using

    telemetry. The user can include one or all of these for telemetry monitoring by

    selecting specific options.

  • secure_mode

    Type: str, one-of [u’cleartext’, u’ssl’]

    Created By: User (optional)

    Description:

    secure (SSL) or cleartext mode of gRPC configuration.

class 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: gen.generatedssuper.GeneratedsSuper

Attributes: * 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 last modified

  • description

    Type: str

    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: str

    Description:

    Id of tenant who created this object

class gen.resource_xsd.InstanceTargetType(import_export=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * import_export

Type: str, one-of [u’import’, u’export’]
class gen.resource_xsd.InterfaceMapType(port_info=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * port_info

class gen.resource_xsd.InterfaceMirrorType(traffic_direction=None, mirror_to=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * traffic_direction

Type: str, 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 gen.resource_xsd.IpAddressesType(ip_address=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ip_address

Type: str, one-of xsd:string

Description:
String of standard notation of ipv4 or ipv6 address
class gen.resource_xsd.IpamDnsAddressType(tenant_dns_server_address=None, virtual_dns_server_name=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * 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: str

    Created By: User (optional)

    Description:

    In case of virtual DNS server, name of virtual DNS server

class 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, created=None, last_modified=None, subscriber_tag=None, vlan_tag=None, dhcp_relay_server=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * subnet

Type: SubnetType

Created By: User (required)

Description:
ip prefix and length for the subnet
  • default_gateway

    Type: str, 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: str, 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: str

    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: str

    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: str

    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

  • created

    Type: xsd:dateTime

    Created By: User (optional)

    Description:

    timestamp when subnet object gets created

  • last_modified

    Type: xsd:dateTime

    Created By: User (optional)

    Description:

    timestamp when subnet object gets updated

  • subscriber_tag

    Type: str

    Created By: User (optional)

    Description:

    This represents subscribers assigned ip addresses from this subnet for fabric

    peer network

  • vlan_tag

    Type: int

    Created By: User (optional)

    Description:

    vlan this subnet belongs to

  • dhcp_relay_server

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    DHCP relay server IP

class gen.resource_xsd.IpamSubnets(subnets=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * subnets

class 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: gen.generatedssuper.GeneratedsSuper

Attributes: * ipam_method

Type: str, one-of [u’dhcp’, u’fixed’]

Created By: User (optional)

  • ipam_dns_method

    Type: str, 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 gen.resource_xsd.JunosServicePorts(service_port=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * service_port

Type: str
class gen.resource_xsd.KeyValuePair(key=None, value=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * key

Type: str
  • value

    Type: str

class gen.resource_xsd.KeyValuePairs(key_value_pair=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * key_value_pair

class gen.resource_xsd.LacpParams(lacp_enable=False, lacp_interval=None, lacp_mode=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * lacp_enable

Type: bool

Description:
Enable or disable this option for configuring LACP related params
  • lacp_interval

    Type: str, one-of [u’fast’, u’slow’]

    Description:

    Timer interval for periodic transmission of LACP packets. Fast mode receives

    packets every second. Slow mode receives packets every 30 seconds.

  • lacp_mode

    Type: str, one-of [u’active’, u’passive’]

    Description:

    Configure this mode to active to initiate transmission of LACP packets and

    respond to LACP packets. LACP packets are not exchanged with passive mode.

class 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: gen.generatedssuper.GeneratedsSuper

Attributes: * linklocal_service_name

Type: str

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: str, 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: str

    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: str, one-of xsd:string

    Created By: User (optional)

    Description:

    Destination ip address to which link local traffic will forwarded

class gen.resource_xsd.LinklocalServicesTypes(linklocal_service_entry=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * linklocal_service_entry

Type: LinklocalServiceEntryType

Created By: User (optional)

Description:
List of link local services
class 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: gen.generatedssuper.GeneratedsSuper

Attributes: * admin_state

Type: bool

Created By: User (optional)

Description:
Administratively up or dowm.
  • monitor_type

    Type: str, 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: str

    Created By: User (optional)

    Description:

    In case monitor protocol is HTTP, type of http method used like GET, PUT, POST

    etc

  • url_path

    Type: str

    Created By: User (optional)

    Description:

    In case monitor protocol is HTTP, URL to be used. In case of ICMP, ip address

  • expected_codes

    Type: str

    Created By: User (optional)

    Description:

    In case monitor protocol is HTTP, expected return code for HTTP operations like

    200 ok.

class 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: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str, one-of [u’HTTP’, u’HTTPS’, u’TCP’, u’UDP’, u’TERMINATED_HTTPS’]
  • protocol_port

    Type: int

  • admin_state

    Type: bool

  • connection_limit

    Type: int

  • default_tls_container

    Type: str

  • sni_containers

    Type: str

class gen.resource_xsd.LoadbalancerMemberType(admin_state=True, status=None, status_description=None, protocol_port=None, weight=1, address=None, subnet_id=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * admin_state

Type: bool

Created By: User (optional)

Description:
Administrative up or down.
  • status

    Type: str

    Description:

    Operational status of the member.

  • status_description

    Type: str

    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: str, one-of xsd:string

    Created By: User (optional)

    Description:

    Ip address of the member

  • subnet_id

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    UUID of the subnet from where the members are reachable.

class 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: gen.generatedssuper.GeneratedsSuper

Attributes: * status

Type: str

Description:
Operating status for this loadbalancer pool.
  • status_description

    Type: str

    Description:

    Operating status description for this loadbalancer pool.

  • admin_state

    Type: bool

    Created By: User (optional)

    Description:

    Administrative up or down

  • protocol

    Type: str, one-of [u’HTTP’, u’HTTPS’, u’TCP’, u’UDP’, u’TERMINATED_HTTPS’]

    Created By: User (optional)

    Description:

    IP protocol string like http, https or tcp.

  • loadbalancer_method

    Type: str, 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: str, 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: str, 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: str

    Created By: User (optional)

    Description:

    To Be Added

class 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: gen.generatedssuper.GeneratedsSuper

Attributes: * status

Type: str

Created By: User (optional)

Description:
Operational status of the load balancer updated by system.
  • provisioning_status

    Type: str

    Created By: User (optional)

    Description:

    Provisioning status of the load balancer updated by system.

  • operating_status

    Type: str

    Created By: User (optional)

    Description:

    Operational status of the load balancer updated by system.

  • vip_subnet_id

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    Subnet UUID of the subnet of VIP, representing virtual network.

  • vip_address

    Type: str, 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 gen.resource_xsd.LocalLinkConnection(switch_info=None, port_index=None, port_id=None, switch_id=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * switch_info

Type: str

Description:
UUID of the Physical-Port with contrail database
  • port_index

    Type: str

    Description:

    Port-Id provided by LLDP, This usually maps to SnmpIndex

  • port_id

    Type: str

    Description:

    Port ID of switch where Baremetal is connected

  • switch_id

    Type: str

    Description:

    Switch hostname

class gen.resource_xsd.LogicalRouterPRListParams(logical_router_uuid=None, physical_router_uuid_list=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * logical_router_uuid

Type: str

Created By: User (required)

Description:
stores destination logical router uuid for dci intra-fabric type.
  • physical_router_uuid_list

    Type: str

    Created By: User (required)

    Description:

    list of physical routers uuid exists in current destination logical-router and

    user has selected this PR for dci intra-fabric route leaks.

class gen.resource_xsd.LogicalRouterPRListType(logical_router_list=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * logical_router_list

Type: LogicalRouterPRListParams

Description:
List of Destination LRs properties
class gen.resource_xsd.LogicalRouterVirtualNetworkType(logical_router_virtual_network_type='ExternalGateway', params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * logical_router_virtual_network_type

Type: str, one-of [u’ExternalGateway’, u’InternalVirtualNetwork’, u’NAPTSourcePool’]

Created By: User (optional)

class gen.resource_xsd.MACLimitControlType(mac_limit=None, mac_limit_action='log', params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * mac_limit

Type: int

Created By: User (required)

Description:
Number of MACs that can be learnt
  • mac_limit_action

    Type: str, one-of [u’log’, u’alarm’, u’shutdown’, u’drop’]

    Created By: User (optional)

    Description:

    Action to be taken when MAC limit exceeds

class gen.resource_xsd.MACMoveLimitControlType(mac_move_limit=None, mac_move_time_window=10, mac_move_limit_action='log', params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * mac_move_limit

Type: int

Created By: User (required)

Description:
Number of MAC moves permitted in mac move time window
  • mac_move_time_window

    Type: int, within [1, 60]

    Created By: User (required)

    Description:

    MAC move time window

  • mac_move_limit_action

    Type: str, one-of [u’log’, u’alarm’, u’shutdown’, u’drop’]

    Created By: User (optional)

    Description:

    Action to be taken when MAC move limit exceeds

class gen.resource_xsd.MacAddressesType(mac_address=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * mac_address

Type: None
class 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: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str

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: str, one-of [u’IPv4’, u’IPv6’]

    Created By: User (required)

class 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, nic_assisted_mirroring=False, nic_assisted_mirroring_vlan=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * analyzer_name

Type: str

Created By: User (optional)

Description:
Name of service instance used as analyzer
  • encapsulation

    Type: str

    Created By: User (optional)

    Description:

    Encapsulation for Mirrored packet, not used currently

  • analyzer_ip_address

    Type: str, one-of xsd:string

    Created By: User (required)

    Description:

    ip address of interface to which mirrored packets are sent

  • analyzer_mac_address

    Type: str

    Created By: User (optional)

    Description:

    mac address of interface to which mirrored packets are sent

  • routing_instance

    Type: str

    Created By: User (required)

    Description:

    Routing instance for the virtual network which analyzer is in

  • 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: str, 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

  • nic_assisted_mirroring

    Type: bool

    Created By: User (optional)

    Description:

    This flag is used to select nic assisted mirroring

  • nic_assisted_mirroring_vlan

    Type: int, within [0, 4094]

    Created By: User (optional)

    Description:

    The VLAN to be tagged on the traffic for NIC to Mirror

class gen.resource_xsd.MulticastSourceGroup(source_address=None, group_address=None, action=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * source_address

Type: str, one-of xsd:string

Created By: User (required)

Description:
Multicast Source Address
  • group_address

    Type: str, one-of xsd:string

    Created By: User (required)

    Description:

    Multicast Group Address

  • action

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

    Created By: User (required)

    Description:

    Pass or deny action for (S,G) matching this rule

class gen.resource_xsd.MulticastSourceGroups(multicast_source_group=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * multicast_source_group

class gen.resource_xsd.NamespaceValue(ipv4_cidr=None, asn=None, mac_addr=None, asn_ranges=None, serial_nums=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ipv4_cidr

Type: SubnetListType

Created By: User (optional)

Description:
Namespace as IPV4 CIDR addresses
  • asn

    Type: AutonomousSystemsType

    Created By: User (optional)

    Description:

    Namespace as Autonomous System Numbers

  • mac_addr

    Type: MacAddressesType

    Created By: User (optional)

    Description:

    Namespace as MAC addresses

  • asn_ranges

    Type: AsnRangeType

    Created By: User (optional)

    Description:

    Namespace as ASN ranges

  • serial_nums

    Type: str

    Created By: User (optional)

    Description:

    Namespace as MAC addresses

class gen.resource_xsd.NetconfParameters(enabled_sensor_params=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * enabled_sensor_params

Type: EnabledSensorParams

Description:

List of different top level sensor params that the user wishes to monitor using

telemetry. The user can include one or all of these for telemetry monitoring by

selecting specific options.

class gen.resource_xsd.NodeProfileRoleType(physical_role=None, rb_roles=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * physical_role

Type: str
  • rb_roles

    Type: str

class gen.resource_xsd.NodeProfileRolesType(role_mappings=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * role_mappings

class gen.resource_xsd.OspfParameters(auth_data=None, hello_interval=10, dead_interval=40, area_id=None, area_type=None, advertise_loopback=None, orignate_summary_lsa=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * auth_data

Type: AuthenticationData

Created By: User (optional)

Description:
Authentication related configuration like type, keys etc.
  • hello_interval

    Type: int

    Created By: User (optional)

    Description:

    Specifies the length of time, in seconds, before the routing device sends a

    hello packet out of an interface.

  • dead_interval

    Type: int

    Created By: User (optional)

    Description:

    Specifies how long OSPF waits before declaring that a neighboring routing device

    is unavailable

  • area_id

    Type: str, one-of xsd:string

    Created By: User (required)

    Description:

    OSPF area ID

  • area_type

    Type: str, one-of [u’nssa’, u’stub’, u’backbone’]

    Created By: User (required)

    Description:

    OSPF area type

  • advertise_loopback

    Type: bool

    Created By: User (optional)

    Description:

    Boolean to enable advertising loopback address.

  • orignate_summary_lsa

    Type: bool

    Created By: User (optional)

    Description:

    Boolean to enable originating summary LSA.

class gen.resource_xsd.PermType(owner=None, owner_access=None, group=None, group_access=None, other_access=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * owner

Type: str
  • owner_access

    Type: int, within [0, 7]

    Description:

    Three bits representing rwx.

    r=read permission,

    w=write permission,

    x=reference permission

  • group

    Type: str

  • 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 gen.resource_xsd.PermType2(owner=None, owner_access=7, global_access=0, share=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * owner

Type: str

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 gen.resource_xsd.PimParameters(rp_ip_address=None, mode='sparse-dense', enable_all_interfaces=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * rp_ip_address

Type: str, one-of xsd:string

Created By: User (required)

Description:
Static rendezvous point IP address.
  • mode

    Type: str, one-of [u’sparse’, u’sparse-dense’, u’dense’]

    Created By: User (optional)

    Description:

    Pim mode.

  • enable_all_interfaces

    Type: bool

    Created By: User (optional)

    Description:

    Boolean to enable PIM on all interfaces.

class gen.resource_xsd.PlaybookInfoListType(playbook_info=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * playbook_info

class gen.resource_xsd.PlaybookInfoType(playbook_uri=None, multi_device_playbook=False, vendor=None, device_family=None, job_completion_weightage=100, sequence_no=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * playbook_uri

Type: str

Created By: User (required)

Description:
uri to the playbook location on the file server
  • multi_device_playbook

    Type: bool

    Description:

    if set to true, the execute-job action url uses the job-template parameter

    ‘device-list’ to execute the playbook in parallel

  • vendor

    Type: str

    Created By: User (optional)

    Description:

    Vendor name

  • device_family

    Type: str

    Created By: User (optional)

    Description:

    Device family name

  • job_completion_weightage

    Type: int

    Description:

    Job percentage completion when this playbook is completed. This attribute value

    should 100 if there is only one playbook defined in the job template. The job-

    completion-weigtages for all playbooks in the same job-template should add up to

    100 exact.

  • sequence_no

    Type: int

    Created By: User (optional)

    Description:

    Sequence number of the playbook

class gen.resource_xsd.PluginProperties(plugin_property=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * plugin_property

Type: PluginProperty

Created By: User (optional)

Description:
List of plugin specific properties (property, value)
class gen.resource_xsd.PluginProperty(property=None, value=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * property

Type: str
  • value

    Type: str

class 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: gen.generatedssuper.GeneratedsSuper

Attributes: * direction

Type: str, one-of [u’ingress’, u’egress’, u’both’]
  • vlan_tag

    Type: int

  • src_mac

    Type: str

  • dst_mac

    Type: str

  • mpls_label

    Type: int

  • service_chain_address

    Type: str, one-of xsd:string

  • ipv6_service_chain_address

    Type: str, one-of xsd:string

    Description:

    String of standard notation of ipv4 or ipv6 address

  • protocol

    Type: str

class gen.resource_xsd.PolicyEntriesType(policy_rule=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * policy_rule

Type: PolicyRuleType

Created By: User (required)

Description:
List of policy rules
class 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, created=None, last_modified=None, description=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * rule_sequence

Type: SequenceType

Created By: User (optional)

Description:
Deprecated, Will be removed because rules themselves are already an ordered list
  • rule_uuid

    Type: str

    Created By: User (optional)

    Description:

    Rule UUID is identifier used in flow records to identify rule

  • direction

    Type: str, one-of [u’>’, u’<>’]

    Created By: User (required)

  • protocol

    Type: str

    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: str

    Created By: User (optional)

    Description:

    Optionally application can be specified instead of protocol and port. not

    currently implemented

  • dst_addresses

    Type: AddressType

    Created By: User (required)

    Description:

    Destination ip matching criteria

  • dst_ports

    Type: PortType

    Created By: User (required)

    Description:

    Range of destination port for layer 4 protocol

  • action_list

    Type: ActionListType

    Created By: User (required)

    Description:

    Actions to be performed if packets match condition

  • ethertype

    Type: str, one-of [u’IPv4’, u’IPv6’]

    Created By: User (required)

  • created

    Type: xsd:dateTime

    Created By: User (optional)

    Description:

    timestamp when security group rule object gets created

  • last_modified

    Type: xsd:dateTime

    Created By: User (optional)

    Description:

    timestamp when security group rule object gets updated

  • description

    Type: str

    Created By: User (optional)

    Description:

    User provided text

class gen.resource_xsd.PolicyStatementType(term=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * term

class gen.resource_xsd.PolicyTermType(term_match_condition=None, term_action_list=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * term_match_condition

class gen.resource_xsd.PortGroupProperties(miimon=None, xmit_hash_policy=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * miimon

Type: int

Description:
Specifies the MII link monitoring frequency in milliseconds.
  • xmit_hash_policy

    Type: str

    Description:

    Transmit hash policy to use for slave selection in balance-xor, 802.3ad, and tlb

    modes.

class gen.resource_xsd.PortInfoType(name=None, type_=None, port_speed=None, channelized=False, channelized_port_speed=None, port_group=None, labels=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * name

Type: str
  • type

    Type: str, one-of [u’fc’, u’ge’, u’xe’, u’xle’, u’et’, u’fte’, u’me’, u’em’]

  • port_speed

    Type: str, one-of [u‘1G’, u‘10G’, u‘40G’, u‘100G’]

  • channelized

    Type: bool

  • channelized_port_speed

    Type: str, one-of [u‘1G’, u‘10G’, u‘40G’, u‘100G’]

  • port_group

    Type: str

  • labels

    Type: str

class gen.resource_xsd.PortMap(protocol=None, src_port=None, dst_port=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str
  • src_port

    Type: int

  • dst_port

    Type: int

class gen.resource_xsd.PortMappings(port_mappings=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * port_mappings

Type: PortMap
class gen.resource_xsd.PortParameters(port_disable=False, port_mtu=None, port_description=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * port_disable

Type: bool
  • port_mtu

    Type: int, within [256, 9216]

  • port_description

    Type: str

class gen.resource_xsd.PortProfileParameters(port_params=None, flow_control=False, lacp_params=None, bpdu_loop_protection=False, port_cos_untrust=False, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * port_params

Type: PortParameters

Description:

User can select this option to configure port parameters such as description,

MTU and port enable or disable.

  • flow_control

    Type: bool

    Description:

    User can enable this option to configure flow control.

  • lacp_params

    Type: LacpParams

    Description:

    Represents LACP configuration parameters.

  • bpdu_loop_protection

    Type: bool

    Description:

    User can enable this option to prevent loops on edge interfaces. This is applied

    on unit with family ethernet-switching.

  • port_cos_untrust

    Type: bool

    Description:

    Enabling this option causes an interface to be not trusted. Untrusting an

    interface is achieved by applying 802.1 IP untrust classifier configuration.

class gen.resource_xsd.PortTranslationPool(protocol=None, port_range=None, port_count=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str
  • port_range

    Type: PortType

    Created By: User (optional)

    Description:

    Port range to be reserved for per layer 4 protocol for PAT

  • port_count

    Type: unsignedShort

    Created By: User (optional)

    Description:

    Number of ports per layer 4 protocol to be reserved for PAT

class gen.resource_xsd.PortTranslationPools(port_translation_pool=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * port_translation_pool

class gen.resource_xsd.PortType(start_port=0, end_port=65535, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * start_port

Type: int, within [-1, 65535]

Created By: User (required)

  • end_port

    Type: int, within [-1, 65535]

    Created By: User (required)

class gen.resource_xsd.PrefixListMatchType(interface_route_table_uuid=None, prefix_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * interface_route_table_uuid

Type: str

Created By: User (required)

Description:
list of interface route table uuids used to build list of prefixes.
  • prefix_type

    Type: str, one-of [u’exact’, u’longer’, u’orlonger’]

class gen.resource_xsd.PrefixMatchType(prefix=None, prefix_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * prefix

Type: str
  • prefix_type

    Type: str, one-of [u’exact’, u’longer’, u’orlonger’]

class gen.resource_xsd.ProtocolBgpType(autonomous_system=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * autonomous_system

Type: int
class gen.resource_xsd.ProtocolOspfType(area=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * area

Type: int
class gen.resource_xsd.ProtocolStaticType(route=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * route

Type: IpPrefixType
class gen.resource_xsd.ProtocolType(protocol=None, port=None, ignore_address=None, source_prefix=None, source_aggregate_prefix_length=None, destination_prefix=None, destination_aggregate_prefix_length=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str
  • port

    Type: int

  • ignore_address

    Type: str, one-of [u’none’, u’source’, u’destination’]

    Created By: User (optional)

    Description:

    Address ignored while creating flows, from the perspective of packets egressing

    the VM. For packets originated by VM, source and destination indicate the

    corresponding IPs in the packet. For packets coming from remote source, source

    indicates destination IP of the packet is ignored and destination indicates

    source IP of the packet is ignored.

  • source_prefix

    Type: SubnetType

    Created By: User (optional)

    Description:

    For packets originated from VM source-prefix is applied to source IP of the

    packet. For packets coming to VM, source-prefix is applied to destination IP of

    the packet

  • source_aggregate_prefix_length

    Type: int

    Created By: User (optional)

    Description:

    Fat flow prefix mask length for IP where source-prefix is applied

  • destination_prefix

    Type: SubnetType

    Created By: User (optional)

    Description:

    For packets originated from VM destination-prefix is applied to destination IP

    of the packet. For packets coming to VM, destination-prefix is applied to source

    IP of the packet

  • destination_aggregate_prefix_length

    Type: int

    Created By: User (optional)

    Description:

    Fat flow prefix mask length for IP where destination-prefix is applied

class gen.resource_xsd.ProviderDetails(segmentation_id=None, physical_network=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * segmentation_id

Type: int, within [0, 4094]
  • physical_network

    Type: str

class gen.resource_xsd.QosIdForwardingClassPair(key=None, forwarding_class_id=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * key

Type: int

Description:
QoS bit value (DSCP or Vlan priority or EXP bit value
  • forwarding_class_id

    Type: int, within [0, 255]

class gen.resource_xsd.QosIdForwardingClassPairs(qos_id_forwarding_class_pair=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * qos_id_forwarding_class_pair

class gen.resource_xsd.QuotaType(defaults=None, floating_ip=None, instance_ip=None, virtual_machine_interface=None, virtual_network=None, virtual_router=None, virtual_DNS=None, virtual_DNS_record=None, bgp_router=None, network_ipam=None, access_control_list=None, network_policy=None, floating_ip_pool=None, service_template=None, service_instance=None, logical_router=None, security_group=None, security_group_rule=None, subnet=None, global_vrouter_config=None, loadbalancer=None, loadbalancer_listener=None, loadbalancer_pool=None, loadbalancer_member=None, loadbalancer_healthmonitor=None, virtual_ip=None, security_logging_object=None, route_table=None, firewall_group=None, firewall_policy=None, firewall_rule=None, host_based_service=0, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * defaults

Type: int

Created By: User (optional)

Description:
Need to clarify
  • floating_ip

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of floating ips

  • instance_ip

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of instance ips

  • virtual_machine_interface

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of virtual machine interfaces

  • virtual_network

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of virtual networks

  • virtual_router

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of logical routers

  • virtual_DNS

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of virtual DNS servers

  • virtual_DNS_record

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of virtual DNS records

  • bgp_router

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of bgp routers

  • network_ipam

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of network IPAMs

  • access_control_list

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of access control lists

  • network_policy

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of network policies

  • floating_ip_pool

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of floating ip pools

  • service_template

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of service templates

  • service_instance

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of service instances

  • logical_router

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of logical routers

  • security_group

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of security groups

  • security_group_rule

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of security group rules

  • subnet

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of subnets

  • global_vrouter_config

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of global vrouter configs

  • loadbalancer

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of loadbalancers

  • loadbalancer_listener

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of loadbalancer listeners

  • loadbalancer_pool

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of loadbalancer pools

  • loadbalancer_member

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of loadbalancer member

  • loadbalancer_healthmonitor

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of loadbalancer health monitors

  • virtual_ip

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of virtual ips

  • security_logging_object

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of security logging objects

  • route_table

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of route tables

  • firewall_group

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of application policy set

  • firewall_policy

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of firewall policy

  • firewall_rule

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of firewall rule

  • host_based_service

    Type: int, within [0, 1]

    Created By: User (optional)

    Description:

    Maximum number of host based service. Actually limited to 0 or 1 for a project

    (can not be unlimited or more than 1)

class gen.resource_xsd.RbacPermType(role_name=None, role_crud=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * role_name

Type: str

Created By: User (required)

Description:
Name of the role
  • role_crud

    Type: str

    Created By: User (required)

    Description:

    String CRUD representing permissions for C=create, R=read, U=update, D=delete.

class gen.resource_xsd.RbacRuleEntriesType(rbac_rule=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * rbac_rule

class gen.resource_xsd.RbacRuleType(rule_object=None, rule_field=None, rule_perms=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * rule_object

Type: str

Created By: User (required)

Description:
Name of the REST API (object) for this rule, * represent all objects
  • rule_field

    Type: str

    Created By: User (optional)

    Description:

    Name of the level one field (property) for this object, * represent all

    properties

  • rule_perms

    Type: RbacPermType

    Created By: User (required)

    Description:

    List of [(role, permissions),...]

class gen.resource_xsd.RouteFilterProperties(route=None, route_type=None, route_type_value=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * route

Type: str

Created By: User (required)

Description:
route filter IP address or host name.
  • route_type

    Type: str, one-of [u’exact’, u’longer’, u’orlonger’, u’prefix-length-range’, u’through’, u’upto’]

  • route_type_value

    Type: str

    Created By: User (optional)

    Description:

    Valid only for through, upto or prefix-length-range RouteFType. Format: for

    prefix-length-range it stores ‘/min-length-/max-length’. through should be

    string, upto stores ‘/number’

class gen.resource_xsd.RouteFilterType(route_filter_properties=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * route_filter_properties

Type: RouteFilterProperties

Description:
List of route filter properties.
class gen.resource_xsd.RouteListType(route=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * route

Type: str
class gen.resource_xsd.RouteOriginOverride(origin_override=False, origin='IGP', params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * origin_override

Type: bool

Created By: User (optional)

Description:
Set true to override Route origin with the given value
  • origin

    Type: str, one-of [u’IGP’, u’EGP’, u’INCOMPLETE’]

    Created By: User (optional)

    Description:

    User define route origin value

class gen.resource_xsd.RouteTableType(route=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * route

Type: RouteType

Description:
List of ip routes with following fields.
class gen.resource_xsd.RouteTargetList(route_target=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * route_target

Type: str
class gen.resource_xsd.RouteType(prefix=None, next_hop=None, next_hop_type=None, community_attributes=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * prefix

Type: str

Description:
Ip prefix/len format prefix
  • next_hop

    Type: str

    Description:

    Ip address or service instance name.

  • next_hop_type

    Type: str, one-of [u’service-instance’, u’ip-address’]

  • community_attributes

    Type: CommunityAttributes

class gen.resource_xsd.RoutedProperties(physical_router_uuid=None, logical_router_uuid=None, routed_interface_ip_address=None, loopback_ip_address=None, routing_protocol=None, bgp_params=None, ospf_params=None, pim_params=None, static_route_params=None, bfd_params=None, routing_policy_params=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * physical_router_uuid

Type: str

Created By: User (required)

Description:
Routed properties for particular physical router for this virtual-network.
  • logical_router_uuid

    Type: str

    Created By: User (required)

    Description:

    Routed properties for particular logical router for this virtual-network.

  • routed_interface_ip_address

    Type: str, one-of xsd:string

    Created By: User (required)

    Description:

    IP address of the routed interface from the VN subnet.

  • loopback_ip_address

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    IP address of the loopback interface from the overlay loopback subnet.

  • routing_protocol

    Type: str, one-of [u’static-routes’, u’bgp’, u’ospf’, u’pim’]

    Created By: User (required)

    Description:

    Protocol used for exchanging route information.

  • bgp_params

    Type: BgpParameters

    Created By: User (optional)

    Description:

    BGP parameters such as ASN, peer IP address, authentication method/key.

  • ospf_params

    Type: OspfParameters

    Created By: User (optional)

    Description:

    OSPF parameters such as area ID, area type, hello-interval, dead-interval,

    authentication method/key.

  • pim_params

    Type: PimParameters

    Created By: User (optional)

    Description:

    PIM parameters such as RP IP address, mode.

  • static_route_params

    Type: StaticRouteParameters

    Created By: User (optional)

    Description:

    Static route parameters such as interface route table uuid, next hop IP address.

  • bfd_params

    Type: BfdParameters

    Created By: User (optional)

    Description:

    BFD parameters such as time interval, detection time multiplier.

  • routing_policy_params

    Type: RoutingPolicyParameters

    Created By: User (optional)

    Description:

    List of import/export routing policy uuids.

class gen.resource_xsd.RoutingBridgingRolesType(rb_roles=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * rb_roles

Type: str
class gen.resource_xsd.RoutingPolicyParameters(import_routing_policy_uuid=None, export_routing_policy_uuid=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * import_routing_policy_uuid

Type: str

Created By: User (optional)

Description:
list of routing policy uuids used as import policies.
  • export_routing_policy_uuid

    Type: str

    Created By: User (optional)

    Description:

    list of routing policy uuids used as export policies.

class gen.resource_xsd.RoutingPolicyServiceInstanceType(left_sequence=None, right_sequence=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Description:

A given routing policy could be attached to both left or right interface of a

service instance. If it is the case, set both the left-sequence and right-

sequence. If you only want to attach it to either left or right, but not both,

then only set the corresponding sequence number. A value of None also means it

is not attached to that interface.

Attributes: * left_sequence

Type: str, one-of xsd:string
  • right_sequence

    Type: str, one-of xsd:string

class gen.resource_xsd.RoutingPolicyType(sequence=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * sequence

Type: str, one-of xsd:string
class gen.resource_xsd.SNMPCredentials(version=2, local_port=None, retries=None, timeout=None, v2_community=None, v3_security_name=None, v3_security_level=None, v3_security_engine_id=None, v3_context=None, v3_context_engine_id=None, v3_authentication_protocol=None, v3_authentication_password=None, v3_privacy_protocol=None, v3_privacy_password=None, v3_engine_id=None, v3_engine_boots=None, v3_engine_time=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * version

Type: int
  • local_port

    Type: int

  • retries

    Type: int

  • timeout

    Type: int

  • v2_community

    Type: str

  • v3_security_name

    Type: str

  • v3_security_level

    Type: str

  • v3_security_engine_id

    Type: str

  • v3_context

    Type: str

  • v3_context_engine_id

    Type: str

  • v3_authentication_protocol

    Type: str

  • v3_authentication_password

    Type: str

  • v3_privacy_protocol

    Type: str

  • v3_privacy_password

    Type: str

  • v3_engine_id

    Type: str

  • v3_engine_boots

    Type: int

  • v3_engine_time

    Type: int

class gen.resource_xsd.SecurityLoggingObjectRuleEntryType(rule_uuid=None, rate=100, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * rule_uuid

Type: str

Created By: User (optional)

Description:

Rule UUID of network policy or security-group. When this is absent it implies

all rules of security-group or network-policy

  • rate

    Type: int

    Created By: User (optional)

    Description:

    Rate at which sessions are logged. When rates are specified at multiple levels,

    the rate which specifies highest frequency is selected

class gen.resource_xsd.SecurityLoggingObjectRuleListType(rule=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * rule

Type: SecurityLoggingObjectRuleEntryType

Created By: User (optional)

Description:

List of rules along with logging rate for each rule. Both rule-uuid and rate are

optional. When rule-uuid is absent then it means all rules of associated SG or

network-policy

class gen.resource_xsd.SequenceType(major=None, minor=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * major

Type: int

Created By: User (required)

  • minor

    Type: int

    Created By: User (required)

class gen.resource_xsd.SerialNumListType(serial_num=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * serial_num

Type: str
class gen.resource_xsd.ServiceApplianceInterfaceType(interface_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * interface_type

Type: str, one-of xsd:string
class gen.resource_xsd.ServiceChainInfo(routing_instance=None, prefix=None, service_chain_address=None, service_instance=None, source_routing_instance=None, service_chain_id=None, sc_head=False, retain_as_path=False, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * routing_instance

Type: str
  • prefix

    Type: str

  • service_chain_address

    Type: str, one-of xsd:string

  • service_instance

    Type: str

  • source_routing_instance

    Type: str

  • service_chain_id

    Type: str

  • sc_head

    Type: bool

  • retain_as_path

    Type: bool

class gen.resource_xsd.ServiceHealthCheckType(enabled=False, health_check_type=None, monitor_type=None, delay=None, delayUsecs=0, timeout=None, timeoutUsecs=0, max_retries=None, http_method=None, url_path=None, expected_codes=None, target_ip_all=False, target_ip_list=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * enabled

Type: bool

Created By: User (optional)

Description:
Administratively enable or disable this health check.
  • health_check_type

    Type: str, one-of [u’link-local’, u’end-to-end’, u’segment’, u’vn-ip-list’]

    Created By: User (required)

    Description:

    Health check type, currently only link-local, end-to-end and segment are

    supported

  • monitor_type

    Type: str, one-of [u’PING’, u’HTTP’, u’BFD’]

    Created By: User (required)

    Description:

    Protocol used to monitor health, currently only HTTP, ICMP(ping), and BFD are

    supported

  • delay

    Type: int

    Created By: User (required)

    Description:

    Time in seconds at which health check is repeated

  • delayUsecs

    Type: int

    Created By: User (optional)

    Description:

    Time in micro seconds at which health check is repeated

  • timeout

    Type: int

    Created By: User (required)

    Description:

    Time in seconds to wait for response

  • timeoutUsecs

    Type: int

    Created By: User (optional)

    Description:

    Time in micro seconds to wait for response

  • max_retries

    Type: int

    Created By: User (required)

    Description:

    Number of failures before declaring health bad

  • http_method

    Type: str

    Created By: User (optional)

    Description:

    In case monitor protocol is HTTP, type of http method used like GET, PUT, POST

    etc

  • url_path

    Type: str

    Created By: User (optional)

    Description:

    In case monitor protocol is HTTP, URL to be used. In case of ICMP, ip address

  • expected_codes

    Type: str

    Created By: User (optional)

    Description:

    In case monitor protocol is HTTP, expected return code for HTTP operations like

    200 ok.

  • target_ip_all

    Type: bool

    Created By: User (optional)

    Description:

    Run BFD for all IP Addresses learnt by mac-ip learning, when enabled.

  • target_ip_list

    Type: IpAddressesType

    Created By: User (optional)

    Description:

    Any address that belongs to the list has to run BFD health check when target-ip-

    all is false.

class gen.resource_xsd.ServiceInstanceInterfaceType(virtual_network=None, ip_address=None, static_routes=None, allowed_address_pairs=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * virtual_network

Type: str

Created By: User (required)

Description:
Interface belongs to this virtual network.
  • ip_address

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    Shared ip for this interface (Only V1)

  • static_routes

    Type: RouteTableType

    Created By: User (optional)

    Description:

    Static routes for this interface (Only V1)

  • allowed_address_pairs

    Type: AllowedAddressPairs

    Created By: User (optional)

    Description:

    Allowed address pairs, list of (IP address, MAC) for this interface

class gen.resource_xsd.ServiceInstanceType(auto_policy=False, availability_zone=None, management_virtual_network=None, left_virtual_network=None, left_ip_address=None, right_virtual_network=None, right_ip_address=None, interface_list=None, scale_out=None, ha_mode=None, virtual_router_id=None, service_virtualization_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * auto_policy

Type: bool

Description:

Set when system creates internal service chains, example SNAT with router

external flag in logical router

  • availability_zone

    Type: str

    Created By: User (optional)

    Description:

    Availability zone used to spawn VM(s) for this service instance, used in version

    1 (V1) only

  • management_virtual_network

    Type: str

    Created By: User (optional)

    Description:

    Deprecated

  • left_virtual_network

    Type: str

    Created By: User (optional)

    Description:

    Deprecated

  • left_ip_address

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    Deprecated

  • right_virtual_network

    Type: str

    Created By: User (optional)

    Description:

    Deprecated

  • right_ip_address

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    Deprecated

  • interface_list

    Type: ServiceInstanceInterfaceType

    Created By: User (required)

    Description:

    List of service instance interface properties. Ordered list as per service

    template

  • scale_out

    Type: ServiceScaleOutType

    Created By: User (optional)

    Description:

    Number of virtual machines in this service instance, used in version 1 (V1) only

  • ha_mode

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

    Created By: User (optional)

    Description:

    When scale-out is greater than one, decides if active-active or active-backup,

    used in version 1 (V1) only

  • virtual_router_id

    Type: str

    Created By: User (optional)

    Description:

    UUID of a virtual-router on which this service instance need to spawn. Used to

    spawn services on CPE device when Nova is not present

  • service_virtualization_type

    Type: str, one-of [u’virtual-machine’, u’network-namespace’, u’vrouter-instance’, u’physical-device’]

    Created By: User (optional)

    Description:

    Service virtualization type decides how individual service instances are

    instantiated

class gen.resource_xsd.ServiceInterfaceTag(interface_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * interface_type

Type: str, one-of xsd:string
class gen.resource_xsd.ServicePropertiesType(retain_as_path=False, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * retain_as_path

Type: bool

Created By: User (optional)

Description:

Indicates if as-path should be retained across service-instances in the service-

chain

class gen.resource_xsd.ServiceScaleOutType(max_instances=1, auto_scale=False, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * max_instances

Type: int

Created By: User (required)

Description:
Maximum number of scale out factor(virtual machines). can be changed dynamically
  • auto_scale

    Type: bool

    Created By: User (required)

    Description:

    Automatically change the number of virtual machines. Not implemented

class gen.resource_xsd.ServiceTemplateInterfaceType(service_interface_type=None, shared_ip=False, static_route_enable=False, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * service_interface_type

Type: str, one-of xsd:string

Created By: User (required)

Description:
Type of service interface supported by this template left, right or other.
  • shared_ip

    Type: bool

    Created By: User (optional)

    Description:

    Shared ip is required on this interface when service instance is scaled out

    (Only V1)

  • static_route_enable

    Type: bool

    Created By: User (optional)

    Description:

    Static routes configured required on this interface of service instance (Only

    V1)

class gen.resource_xsd.ServiceTemplateType(version=1, service_mode=None, service_type=None, image_name=None, service_scaling=False, interface_type=None, flavor=None, ordered_interfaces=False, service_virtualization_type=None, availability_zone_enable=False, vrouter_instance_type=None, instance_data=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * version

Type: int

Created By: User (optional)

Description:

Version of service template.

1: Service virtual machines and interfaces are automatically launched,

monitored and deleted.

2: User creates all objects( virtual machines and interfaces) and manages

the life cycle.

Useful when virtual machines and interfaces are managed via heat template
  • service_mode

    Type: str, one-of [u’transparent’, u’in-network’, u’in-network-nat’]

    Created By: User (required)

    Description:

    Service instance mode decides how packets are forwarded across the service

  • service_type

    Type: str, one-of [u’firewall’, u’analyzer’, u’source-nat’, u’loadbalancer’]

    Created By: User (required)

    Description:

    Service instance mode decides how routing happens across the service

  • image_name

    Type: str

    Created By: User (optional)

    Description:

    Glance image name for the service virtual machine, Version 1 only

  • service_scaling

    Type: bool

    Created By: User (optional)

    Description:

    Enable scaling of service virtual machines, Version 1 only

  • interface_type

    Type: ServiceTemplateInterfaceType

    Created By: User (required)

    Description:

    List of interfaces which decided number of interfaces and type

  • flavor

    Type: str

    Created By: User (optional)

    Description:

    Nova flavor used for service virtual machines, Version 1 only

  • ordered_interfaces

    Type: bool

    Created By: User (optional)

    Description:

    Deprecated

  • service_virtualization_type

    Type: str, one-of [u’virtual-machine’, u’network-namespace’, u’vrouter-instance’, u’physical-device’]

    Created By: User (optional)

    Description:

    Service virtualization type decides how individual service instances are

    instantiated

  • availability_zone_enable

    Type: bool

    Created By: User (optional)

    Description:

    Enable availability zone for version 1 service instances

  • vrouter_instance_type

    Type: str, one-of [u’libvirt-qemu’, u’docker’]

    Created By: User (optional)

    Description:

    Mechanism used to spawn service instance, when vrouter is spawning

    instances.Allowed values libvirt-qemu, docker or netns

  • instance_data

    Type: str

    Created By: User (optional)

    Description:

    Opaque string (typically in json format) used to spawn a vrouter-instance.

class gen.resource_xsd.ServiceVirtualNetworkType(virtual_network_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * virtual_network_type

Type: str, one-of xsd:string
class gen.resource_xsd.SflowParameters(stats_collection_frequency=None, agent_id=None, adaptive_sample_rate=300, enabled_interface_type=None, enabled_interface_params=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * stats_collection_frequency

Type: StatsCollectionFrequency

Description:

Represents polling interval and sample rate either at the global level or at per

interface level. Polling interval is specified in seconds that the device waits

between port statistics update messages. Sample rate is specified as a number

(one packet out of number).

  • agent_id

    Type: str, one-of xsd:string

    Description:

    IP address to be assigned as the agent ID for the sFlow agent.

  • adaptive_sample_rate

    Type: int, within [300, 900]

    Created By: User (optional)

    Description:

    Represents maximum number of samples that should be generated per line card.

  • enabled_interface_type

    Type: str, one-of [u’all’, u’fabric’, u’service’, u’access’, u’custom’]

    Description:

    User can enable sflow either on all interfaces or all fabric ports or all access

    ports or custom list of interfaces.

  • enabled_interface_params

    Type: EnabledInterfaceParams

    Description:

    If interface type is set to custom, this represents the list of physical

    interfaces to be enabled for sflow. User can specify polling interval and sample

    rate for each interface in this custom list.

class gen.resource_xsd.ShareType(tenant=None, tenant_access=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * tenant

Type: str

Created By: User (required)

Description:
Name of tenant with whom the object is shared
  • tenant_access

    Type: int, within [0, 7]

    Created By: User (required)

    Description:

    Allowed permissions in sharing

class gen.resource_xsd.SloRateType(rate=-1, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * rate

Type: int

Description:
Rate at which sessions are logged
class gen.resource_xsd.SnmpParameters(enabled_sensor_params=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * enabled_sensor_params

Type: EnabledSensorParams

Description:

List of different top level sensor params that the user wishes to monitor using

telemetry. The user can include one or all of these for telemetry monitoring by

selecting specific options.

class gen.resource_xsd.SriovInfo(sriov_physical_interface=None, sriov_vf=None, sriov_physical_net=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * sriov_physical_interface

Type: str

Description:
SRIOV Physical Interface
  • sriov_vf

    Type: int

    Description:

    SRIOV Virtual Function

  • sriov_physical_net

    Type: str

    Description:

    SRIOV Physical Network

class gen.resource_xsd.StaticMirrorNhType(vtep_dst_ip_address=None, vtep_dst_mac_address=None, vni=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * vtep_dst_ip_address

Type: str, one-of xsd:string

Created By: User (required)

Description:
ip address of destination vtep
  • vtep_dst_mac_address

    Type: str

    Created By: User (optional)

    Description:

    mac address of destination vtep

  • vni

    Type: int, within [1, 16777215]

    Created By: User (required)

    Description:

    Vni of vtep

class gen.resource_xsd.StaticRouteEntriesType(route=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * route

class gen.resource_xsd.StaticRouteParameters(interface_route_table_uuid=None, next_hop_ip_address=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * interface_route_table_uuid

Type: str

Created By: User (required)

Description:
list of interface route table uuids used to build list of prefixes.
  • next_hop_ip_address

    Type: str, one-of xsd:string

    Created By: User (required)

    Description:

    List of next-hop IP addresses.

class gen.resource_xsd.StaticRouteType(prefix=None, next_hop=None, route_target=None, community=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * prefix

Type: str
  • next_hop

    Type: str

  • route_target

    Type: str

  • community

    Type: str

class gen.resource_xsd.StatsCollectionFrequency(sample_rate=2000, polling_interval=0, direction=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * sample_rate

Type: int, within [1, 16777215]

Created By: User (optional)

  • polling_interval

    Type: int, within [0, 3600]

    Created By: User (optional)

  • direction

    Type: str, one-of [u’ingress’, u’egress’]

    Created By: User (optional)

class gen.resource_xsd.StormControlParameters(storm_control_actions=None, recovery_timeout=None, no_unregistered_multicast=False, no_registered_multicast=False, no_unknown_unicast=False, no_multicast=False, no_broadcast=False, bandwidth_percent=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * storm_control_actions

Type: str, one-of [u’interface-shutdown’]

Description:

Default action (Discard) is implicit. In addition, other list of actions can be

specified here

  • recovery_timeout

    Type: int

    Created By: User (optional)

    Description:

    Timeout in seconds. This enables the affected interface to recover automatically

    from the error condition after the specified period of time

  • no_unregistered_multicast

    Type: bool

    Description:

    if set to true, disable unregistered multicast traffic storm control

  • no_registered_multicast

    Type: bool

    Description:

    if set to true, disable registered multicast traffic storm control

  • no_unknown_unicast

    Type: bool

    Description:

    if set to true, disable unknown unicast traffic storm control

  • no_multicast

    Type: bool

    Description:

    if set to true, disable muticast traffic storm control

  • no_broadcast

    Type: bool

    Description:

    if set to true, disable broadcast traffic storm control

  • bandwidth_percent

    Type: int

    Created By: User (required)

    Description:

    Configure storm control bandwidth level as percentage

class gen.resource_xsd.StructuredSyslogDSCPMap(dscpListIPv4=None, dscpListIPv6=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * dscpListIPv4

class gen.resource_xsd.StructuredSyslogDSCPType(dscp_value=None, alias_code=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * dscp_value

Type: str
  • alias_code

    Type: str

class gen.resource_xsd.StructuredSyslogLANSegmentList(LANSegmentList=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * LANSegmentList

class gen.resource_xsd.StructuredSyslogLANSegmentType(vpn=None, network_ranges=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * vpn

Type: str
  • network_ranges

    Type: str

class gen.resource_xsd.StructuredSyslogLinkType(overlay=None, underlay=None, link_type=None, traffic_destination=None, metadata=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * overlay

Type: str
  • underlay

    Type: str

  • link_type

    Type: str

  • traffic_destination

    Type: str

  • metadata

    Type: str

class gen.resource_xsd.StructuredSyslogLinkmap(links=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * links

class gen.resource_xsd.SubnetListType(subnet=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * subnet

class gen.resource_xsd.SubnetType(ip_prefix=None, ip_prefix_len=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ip_prefix

Type: str
  • ip_prefix_len

    Type: int

class gen.resource_xsd.TelemetryResourceInfo(name=None, path=None, rate=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * name

Type: str
  • path

    Type: str

  • rate

    Type: str

class gen.resource_xsd.TelemetryStateInfo(resource=None, server_ip=None, server_port=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * resource

  • server_ip

    Type: str

  • server_port

    Type: int

class gen.resource_xsd.TermActionListType(update=None, action=None, action_next_value=None, external=None, as_path_expand=None, as_path_prepend=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * update

  • action

    Type: str, one-of [u’reject’, u’accept’, u’next’]

  • action_next_value

    Type: str, one-of [u’term’, u’policy’]

    Created By: User (optional)

  • external

    Type: str, one-of [u’ospf-type-1’, u’ospf-type-2’]

    Created By: User (optional)

  • as_path_expand

    Type: str

    Created By: User (optional)

    Description:

    Valid only for network-device TermType. string should be in format of AS

    number(s) seperated by spaces

  • as_path_prepend

    Type: str

    Created By: User (optional)

    Description:

    Valid only for network-device TermType. string should be in format of AS

    number(s) seperated by spaces

class gen.resource_xsd.TermMatchConditionType(protocol=None, prefix=None, community=None, community_list=None, community_match_all=None, extcommunity_list=None, extcommunity_match_all=None, family=None, as_path=None, external=None, local_pref=None, nlri_route_type=None, prefix_list=None, route_filter=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str, one-of [u’xmpp’, u’service-chain’, u’interface’, u’interface-static’, u’service-interface’, u’bgpaas’, u’bgp’, u’static’, u’aggregate’, u’direct’, u’pim’, u’evpn’, u’ospf’, u’ospf3’]
  • prefix

    Type: PrefixMatchType

  • community

    Type: str

  • community_list

    Type: str

  • community_match_all

    Type: bool

  • extcommunity_list

    Type: str

  • extcommunity_match_all

    Type: bool

  • family

    Type: str, one-of [u’inet’, u’inet-vpn’, u’evpn’]

    Created By: User (optional)

  • as_path

    Type: int

    Created By: User (optional)

  • external

    Type: str, one-of [u’ospf-type-1’, u’ospf-type-2’]

    Created By: User (optional)

  • local_pref

    Type: int

    Created By: User (optional)

  • nlri_route_type

    Type: int

    Created By: User (optional)

    Description:

    list of integer values in range of 1 to 10 inclusive.

  • prefix_list

    Type: PrefixListMatchType

    Created By: User (optional)

    Description:

    list of prefixes from interface route table uuids with prefix types.

  • route_filter

    Type: RouteFilterType

    Created By: User (optional)

class gen.resource_xsd.TimerType(start_time=None, on_interval=None, off_interval=None, end_time=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * start_time

Type: xsd:dateTime

Created By: User (required)

  • on_interval

    Type: str

    Created By: User (required)

  • off_interval

    Type: str

    Created By: User (required)

  • end_time

    Type: xsd:dateTime

    Created By: User (required)

class gen.resource_xsd.UserCredentials(username=None, password=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * username

Type: str
  • password

    Type: str

class gen.resource_xsd.UserDefinedLogStat(name=None, pattern=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * name

Type: str

Created By: User (required)

Description:
Name of the stat
  • pattern

    Type: str

    Created By: User (required)

    Description:

    Perl type regular expression pattern to match

class gen.resource_xsd.UserDefinedLogStatList(statlist=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * statlist

class gen.resource_xsd.UuidType(uuid_mslong=None, uuid_lslong=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * uuid_mslong

Type: int
  • uuid_lslong

    Type: int

class gen.resource_xsd.UveKeysType(uve_key=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * uve_key

Type: str

Created By: User (required)

Description:
List of UVE tables where this alarm config should be applied
class gen.resource_xsd.VMIVirtualPortGroupAttributes(vlan_tag=None, native_vlan_tag=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * vlan_tag

Type: int, within [0, 4094]

Created By: User (optional)

Description:
Tagged VLAN
  • native_vlan_tag

    Type: int, within [0, 4094]

    Created By: User (optional)

    Description:

    Untagged VLAN

class gen.resource_xsd.VendorHardwaresType(vendor_hardware=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * vendor_hardware

Type: str
class gen.resource_xsd.VirtualDnsRecordType(record_name=None, record_type=None, record_class=None, record_data=None, record_ttl_seconds=None, record_mx_preference=None, record_source_name=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * record_name

Type: str

Created By: User (required)

Description:
DNS name to be resolved
  • record_type

    Type: str, one-of [u’A’, u’AAAA’, u’CNAME’, u’PTR’, u’NS’, u’MX’]

    Created By: User (optional)

    Description:

    DNS record type can be A, AAAA, CNAME, PTR, NS and MX

  • record_class

    Type: str, one-of [u’IN’]

    Created By: User (optional)

    Description:

    DNS record class supported is IN

  • record_data

    Type: str

    Created By: User (required)

    Description:

    DNS record data is either ip address or string depending on type

  • record_ttl_seconds

    Type: int

    Created By: User (optional)

    Description:

    Time To Live for this DNS record

  • record_mx_preference

    Type: int

    Created By: User (optional)

  • record_source_name

    Type: str

    Description:

    name of the compute node which sends add for A type or PTR type dns record for

    vm

class gen.resource_xsd.VirtualDnsType(domain_name=None, dynamic_records_from_client=None, record_order='random', default_ttl_seconds=None, next_virtual_DNS=None, floating_ip_record=None, external_visible=False, reverse_resolution=False, soa_record=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * domain_name

Type: str

Created By: User (required)

Description:
Default domain name for this virtual DNS server
  • dynamic_records_from_client

    Type: bool

    Created By: User (optional)

    Description:

    Allow automatic addition of records on VM launch, default is True

  • record_order

    Type: str, one-of [u’fixed’, u’random’, u’round-robin’]

    Created By: User (optional)

    Description:

    Order of DNS load balancing, fixed, random, round-robin. Default is random

  • default_ttl_seconds

    Type: int

    Created By: User (optional)

    Description:

    Default Time To Live for DNS records

  • next_virtual_DNS

    Type: str

    Created By: User (optional)

    Description:

    Next virtual DNS server to lookup if record is not found. Default is proxy to

    infrastructure DNS

  • floating_ip_record

    Type: str, one-of [u’dashed-ip’, u’dashed-ip-tenant-name’, u’vm-name’, u’vm-name-tenant-name’]

    Created By: User (optional)

    Description:

    Decides how floating ip records are added

  • external_visible

    Type: bool

    Created By: User (optional)

    Description:

    Currently this option is not supported

  • reverse_resolution

    Type: bool

    Created By: User (optional)

    Description:

    Allow reverse DNS resolution, ip to name mapping

  • soa_record

    Type: DnsSoaRecordType

    Created By: User (optional)

    Description:

    Dns soa record values

class gen.resource_xsd.VirtualIpType(address=None, status=None, status_description=None, admin_state=True, protocol=None, protocol_port=None, connection_limit=None, subnet_id=None, persistence_cookie_name=None, persistence_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * address

Type: str, one-of xsd:string

Description:
IP address automatically allocated by system.
  • status

    Type: str

    Description:

    Operating status for this virtual ip.

  • status_description

    Type: str

    Description:

    Operating status description this virtual ip.

  • admin_state

    Type: bool

    Created By: User (optional)

    Description:

    Administrative up or down.

  • protocol

    Type: str, one-of [u’HTTP’, u’HTTPS’, u’TCP’, u’UDP’, u’TERMINATED_HTTPS’]

    Created By: User (optional)

    Description:

    IP protocol string like http, https or tcp.

  • protocol_port

    Type: int

    Created By: User (optional)

    Description:

    Layer 4 protocol destination port.

  • connection_limit

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of concurrent connections

  • subnet_id

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    UUID of subnet in which to allocate the Virtual IP.

  • persistence_cookie_name

    Type: str

    Created By: User (optional)

    Description:

    Set this string if the relation of client and server(pool member) need to

    persist.

  • persistence_type

    Type: str, 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.

class gen.resource_xsd.VirtualMachineInterfacePropertiesType(service_interface_type=None, interface_mirror=None, local_preference=None, sub_interface_vlan_tag=None, max_flows=0, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * service_interface_type

Type: str, one-of xsd:string

Created By: User (optional)

Description:
This interface belongs to Service Instance and is tagged as left, right or other
  • interface_mirror

    Type: InterfaceMirrorType

    Created By: User (optional)

    Description:

    Interface Mirror configuration

  • local_preference

    Type: int

    Created By: User (optional)

    Description:

    BGP route local preference for routes representing this interface, higher value

    is higher preference

  • sub_interface_vlan_tag

    Type: int

    Created By: User (optional)

    Description:

    802.1Q VLAN tag to be used if this interface is sub-interface for some other

    interface.

  • max_flows

    Type: int, within [0, 4294967296]

    Created By: User (optional)

    Description:

    Maximum number of flows permitted on VMI

class gen.resource_xsd.VirtualNetworkPolicyType(sequence=None, timer=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * sequence

Type: SequenceType

Created By: User (optional)

Description:
Sequence number to specify order of policy attachment to network
  • timer

    Type: TimerType

    Created By: User (optional)

    Description:

    Timer to specify when the policy can be active

class gen.resource_xsd.VirtualNetworkRoutedPropertiesType(routed_properties=None, shared_across_all_lrs=False, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * routed_properties

Type: RoutedProperties

Description:
List of routed properties for virtual network.
  • shared_across_all_lrs

    Type: bool

    Created By: User (optional)

    Description:

    Allow sharing of this routed virtual network across all LR’s in the system.

class gen.resource_xsd.VirtualNetworkType(allow_transit=None, network_id=None, vxlan_network_identifier=None, forwarding_mode=None, rpf=None, mirror_destination=False, max_flows=0, mtu=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * allow_transit

Type: bool

Created By: User (optional)

Description:

Enables transitive property for route imports.

If B imports routes of A and C imports from B,

then if B is transitive then C will have routes from A.

  • network_id

    Type: int

    Description:

    Not currently in used

  • vxlan_network_identifier

    Type: int, within [1, 16777215]

    Created By: User (required)

    Description:

    VxLAN VNI value for this network

  • forwarding_mode

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

    Created By: User (optional)

    Description:

    Packet forwarding mode for this virtual network

  • rpf

    Type: str, one-of [u’enable’, u’disable’]

    Created By: User (optional)

    Description:

    Flag used to disable Reverse Path Forwarding(RPF) check for this network

  • mirror_destination

    Type: bool

    Created By: User (optional)

    Description:

    Flag to mark the virtual network as mirror destination network

  • max_flows

    Type: int, within [0, 4294967296]

    Created By: User (optional)

    Description:

    Maximum number of flows permitted on each VMI of the VN

  • mtu

    Type: int, within [0, 9216]

    Created By: User (optional)

    Description:

    MTU value for this network

class gen.resource_xsd.VirtualRouterNetworkIpamType(allocation_pools=None, subnet=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * allocation_pools

Type: AllocationPoolType

Created By: User (optional)

Description:
List of ranges of ip address for vrouter specific allocation
  • subnet

    Type: SubnetType

    Created By: User (optional)

    Description:

    List of ip prefix and length for vrouter specific subnets

class gen.resource_xsd.VnSubnetsType(ipam_subnets=None, host_routes=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ipam_subnets

  • host_routes

    Type: RouteTableType

    Created By: User (optional)

    Description:

    Common host routes to be sent via DHCP for VM(s) in all the subnets, Next hop

    for these routes is always default gateway

class gen.resource_xsd.VpgInterfaceParametersType(ae_num=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ae_num

Type: int
class gen.resource_xsd.VrfAssignRuleType(match_condition=None, vlan_tag=None, routing_instance=None, ignore_acl=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * match_condition

  • vlan_tag

    Type: int

  • routing_instance

    Type: str

  • ignore_acl

    Type: bool

class gen.resource_xsd.VrfAssignTableType(vrf_assign_rule=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * vrf_assign_rule

Table Of Contents

Previous topic

Library API Details

Next topic

Contrail Configuration API Specification

This Page