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

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

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

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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.ConfigRoot(name=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: object

Created By:

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

Created By:

Properties:
  • attachment_address

    Type: AttachmentAddressType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: object

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

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’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Data center interconnect mode one of L2 stretch or L3

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

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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

  • 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 data-center-interconnect.

Parameters:ref_obj – LogicalRouter 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
display_name

Get display-name for data-center-interconnect.

Returns:xsd:string object
dump()

Display data-center-interconnect object in compact form.

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_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_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_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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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_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: object

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

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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_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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

Created By:

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: object

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.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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 (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_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
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_fq_name()

Return FQN of fabric in list form.

get_fq_name_str()

Return FQN of fabric as colon delimited string.

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_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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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.FirewallPolicy(name=None, parent_obj=None, draft_mode_state=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

global analytics config related data

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

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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, 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: object

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

  • 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: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

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

  • 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
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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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.Hardware(name=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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.InterfaceRouteTable(name=None, parent_obj=None, interface_route_table_routes=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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_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_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: object

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_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: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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_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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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_type=None, id_perms=None, perms2=None, annotations=None, display_name=None, *args, **kwargs)

Bases: object

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_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: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • 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_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: object

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

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

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