This module defines the classes for every configuration element managed by the system
Bases: future.types.newobject.newobject
Type: AclEntriesType
Created By: System
Operations Allowed: CRUD
Description:
Automatically generated by system based on security groups or network policies.
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.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Get access-control-list-entries for access-control-list.
| Returns: | AclEntriesType object |
|---|
Get access-control-list-hash for access-control-list.
| Returns: | xsd:unsignedLong object |
|---|
Add tag to access-control-list.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for access-control-list.
| Returns: | KeyValuePairs object |
|---|
Get display-name for access-control-list.
| Returns: | xsd:string object |
|---|
Display access-control-list object in compact form.
Return FQN of access-control-list in list form.
Return FQN of access-control-list as colon delimited string.
Return FQN of access-control-list’s parent in list form.
Return FQN of access-control-list’s parent as colon delimted string.
Return tag list for access-control-list.
| Returns: | list of <Tag> |
|---|
Return object type (access-control-list).
Get id-perms for access-control-list.
| Returns: | IdPermsType object |
|---|
Get perms2 for access-control-list.
| Returns: | PermType2 object |
|---|
Set tag for access-control-list.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for access-control-list.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Type: str, one-of [u’created’, u’updated’, u’deleted’]
Created By: User (optional)
Operations Allowed: R
Description:
Type: SubnetListType
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of IP prefix
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to address-group.
| Parameters: | ref_obj – Tag object |
|---|
Get address-group-prefix for address-group.
| Returns: | SubnetListType object |
|---|
Get annotations for address-group.
| Returns: | KeyValuePairs object |
|---|
Get display-name for address-group.
| Returns: | xsd:string object |
|---|
Get draft-mode-state for address-group.
| Returns: | DraftModeState object |
|---|
Display address-group object in compact form.
Return list of all firewall-rules using this address-group
Return FQN of address-group in list form.
Return FQN of address-group as colon delimited string.
Return FQN of address-group’s parent in list form.
Return FQN of address-group’s parent as colon delimted string.
Return tag list for address-group.
| Returns: | list of <Tag> |
|---|
Return object type (address-group).
Get id-perms for address-group.
| Returns: | IdPermsType object |
|---|
Get perms2 for address-group.
| Returns: | PermType2 object |
|---|
Set tag for address-group.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for address-group.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
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.,
Type: int, within [0, 2]
Created By: User (required)
Operations Allowed: CRUD
Description:
Severity level for the alarm.
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}, ...]}]}
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to alarm.
| Parameters: | ref_obj – Tag object |
|---|
Get alarm-rules for alarm.
| Returns: | AlarmOrList object |
|---|
Get alarm-severity for alarm.
| Returns: | AlarmSeverity object |
|---|
Get annotations for alarm.
| Returns: | KeyValuePairs object |
|---|
Get display-name for alarm.
| Returns: | xsd:string object |
|---|
Display alarm object in compact form.
Return FQN of alarm in list form.
Return FQN of alarm as colon delimited string.
Return FQN of alarm’s parent in list form.
Return FQN of alarm’s parent as colon delimted string.
Return tag list for alarm.
| Returns: | list of <Tag> |
|---|
Return object type (alarm).
Get id-perms for alarm.
| Returns: | IdPermsType object |
|---|
Get perms2 for alarm.
| Returns: | PermType2 object |
|---|
Set tag for alarm.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for alarm.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get uve-keys for alarm.
| Returns: | UveKeysType object |
|---|
Bases: future.types.newobject.newobject
alias ip is a ip that can be assigned to virtual-machine-interface(VMI), By doing so VMI can now be part of the alias ip network. packets originating with alias-ip as the source-ip belongs to alias- ip-network
Type: str, one-of xsd:string
Created By: User (required)
Operations Allowed: CR
Description:
Alias ip address.
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
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (required)
Operations Allowed: CRUD
Description:
Reference to project from which this alias ip was allocated.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to virtual machine interface to which this alias ip is attached.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add project to alias-ip.
| Parameters: | ref_obj – Project object |
|---|
Add tag to alias-ip.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-machine-interface to alias-ip.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Get alias-ip-address for alias-ip.
| Returns: | IpAddressType object |
|---|
Get alias-ip-address-family for alias-ip.
| Returns: | IpAddressFamilyType object |
|---|
Get annotations for alias-ip.
| Returns: | KeyValuePairs object |
|---|
Get display-name for alias-ip.
| Returns: | xsd:string object |
|---|
Display alias-ip object in compact form.
Return FQN of alias-ip in list form.
Return FQN of alias-ip as colon delimited string.
Return FQN of alias-ip’s parent in list form.
Return FQN of alias-ip’s parent as colon delimted string.
Return project list for alias-ip.
| Returns: | list of <Project> |
|---|
Return tag list for alias-ip.
| Returns: | list of <Tag> |
|---|
Return object type (alias-ip).
Return virtual-machine-interface list for alias-ip.
| Returns: | list of <VirtualMachineInterface> |
|---|
Get id-perms for alias-ip.
| Returns: | IdPermsType object |
|---|
Get perms2 for alias-ip.
| Returns: | PermType2 object |
|---|
Set project for alias-ip.
| Parameters: | ref_obj – Project object |
|---|
Set project list for alias-ip.
| Parameters: | ref_obj_list – list of Project object |
|---|
Set tag for alias-ip.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for alias-ip.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-machine-interface for alias-ip.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Set virtual-machine-interface list for alias-ip.
| Parameters: | ref_obj_list – list of VirtualMachineInterface object |
|---|
Bases: future.types.newobject.newobject
Alias ip pool is set of addresses that are carved out of a given network. Ip(s) from this set can be assigned to virtual-machine-interface so that they become members of this network
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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.
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
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to alias-ip-pool.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for alias-ip-pool.
| Returns: | KeyValuePairs object |
|---|
Get display-name for alias-ip-pool.
| Returns: | xsd:string object |
|---|
Display alias-ip-pool object in compact form.
Return FQN of alias-ip-pool in list form.
Return FQN of alias-ip-pool as colon delimited string.
Return FQN of alias-ip-pool’s parent in list form.
Return FQN of alias-ip-pool’s parent as colon delimted string.
Return list of all projects using this alias-ip-pool
Return tag list for alias-ip-pool.
| Returns: | list of <Tag> |
|---|
Return object type (alias-ip-pool).
Get id-perms for alias-ip-pool.
| Returns: | IdPermsType object |
|---|
Get perms2 for alias-ip-pool.
| Returns: | PermType2 object |
|---|
Set tag for alias-ip-pool.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for alias-ip-pool.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Analytics node is object representing a logical node in system which serves operational API and analytics collector.
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.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to analytics-alarm-node.
| Parameters: | ref_obj – Tag object |
|---|
Get analytics-alarm-node-ip-address for analytics-alarm-node.
| Returns: | IpAddressType object |
|---|
Get annotations for analytics-alarm-node.
| Returns: | KeyValuePairs object |
|---|
Get display-name for analytics-alarm-node.
| Returns: | xsd:string object |
|---|
Display analytics-alarm-node object in compact form.
Return FQN of analytics-alarm-node in list form.
Return FQN of analytics-alarm-node as colon delimited string.
Return FQN of analytics-alarm-node’s parent in list form.
Return FQN of analytics-alarm-node’s parent as colon delimted string.
Return tag list for analytics-alarm-node.
| Returns: | list of <Tag> |
|---|
Return object type (analytics-alarm-node).
Get id-perms for analytics-alarm-node.
| Returns: | IdPermsType object |
|---|
Get perms2 for analytics-alarm-node.
| Returns: | PermType2 object |
|---|
Set tag for analytics-alarm-node.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for analytics-alarm-node.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Analytics node is object representing a logical node in system which serves operational API and analytics collector.
Type: str, one-of xsd:string
Created By: User (admin-only)
Operations Allowed: CRUD
Description:
Ip address of the analytics node, set while provisioning.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to analytics-node.
| Parameters: | ref_obj – Tag object |
|---|
Get analytics-node-ip-address for analytics-node.
| Returns: | IpAddressType object |
|---|
Get annotations for analytics-node.
| Returns: | KeyValuePairs object |
|---|
Get display-name for analytics-node.
| Returns: | xsd:string object |
|---|
Display analytics-node object in compact form.
Return FQN of analytics-node in list form.
Return FQN of analytics-node as colon delimited string.
Return FQN of analytics-node’s parent in list form.
Return FQN of analytics-node’s parent as colon delimted string.
Return tag list for analytics-node.
| Returns: | list of <Tag> |
|---|
Return object type (analytics-node).
Get id-perms for analytics-node.
| Returns: | IdPermsType object |
|---|
Get perms2 for analytics-node.
| Returns: | PermType2 object |
|---|
Set tag for analytics-node.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for analytics-node.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Analytics node is object representing a logical node in system which serves operational API and analytics collector.
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.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to analytics-snmp-node.
| Parameters: | ref_obj – Tag object |
|---|
Get analytics-snmp-node-ip-address for analytics-snmp-node.
| Returns: | IpAddressType object |
|---|
Get annotations for analytics-snmp-node.
| Returns: | KeyValuePairs object |
|---|
Get display-name for analytics-snmp-node.
| Returns: | xsd:string object |
|---|
Display analytics-snmp-node object in compact form.
Return FQN of analytics-snmp-node in list form.
Return FQN of analytics-snmp-node as colon delimited string.
Return FQN of analytics-snmp-node’s parent in list form.
Return FQN of analytics-snmp-node’s parent as colon delimted string.
Return tag list for analytics-snmp-node.
| Returns: | list of <Tag> |
|---|
Return object type (analytics-snmp-node).
Get id-perms for analytics-snmp-node.
| Returns: | IdPermsType object |
|---|
Get perms2 for analytics-snmp-node.
| Returns: | PermType2 object |
|---|
Set tag for analytics-snmp-node.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for analytics-snmp-node.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
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).
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to api-access-list.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for api-access-list.
| Returns: | KeyValuePairs object |
|---|
Get api-access-list-entries for api-access-list.
| Returns: | RbacRuleEntriesType object |
|---|
Get display-name for api-access-list.
| Returns: | xsd:string object |
|---|
Display api-access-list object in compact form.
Return FQN of api-access-list in list form.
Return FQN of api-access-list as colon delimited string.
Return FQN of api-access-list’s parent in list form.
Return FQN of api-access-list’s parent as colon delimted string.
Return tag list for api-access-list.
| Returns: | list of <Tag> |
|---|
Return object type (api-access-list).
Get id-perms for api-access-list.
| Returns: | IdPermsType object |
|---|
Get perms2 for api-access-list.
| Returns: | PermType2 object |
|---|
Set tag for api-access-list.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for api-access-list.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Type: str, one-of [u’created’, u’updated’, u’deleted’]
Created By: User (optional)
Operations Allowed: R
Description:
Type: bool
Created By: User (optional)
Operations Allowed: R
Description:
If set, indicates application policy set to be applied to all application tags
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (required)
Operations Allowed: CRUD
Description:
Reference to firewall-policy attached to this application-policy
Created By: System
Operations Allowed: CRUD
Description:
Reference to global-vrouter-config is automatically created by system for global
application policy sets
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add firewall-policy to application-policy-set.
| Parameters: |
|
|---|
Add global-vrouter-config to application-policy-set.
| Parameters: | ref_obj – GlobalVrouterConfig object |
|---|
Add tag to application-policy-set.
| Parameters: | ref_obj – Tag object |
|---|
Get all-applications for application-policy-set.
| Returns: | xsd:boolean object |
|---|
Get annotations for application-policy-set.
| Returns: | KeyValuePairs object |
|---|
Get display-name for application-policy-set.
| Returns: | xsd:string object |
|---|
Get draft-mode-state for application-policy-set.
| Returns: | DraftModeState object |
|---|
Display application-policy-set object in compact form.
Return firewall-policy list for application-policy-set.
| Returns: | list of tuple <FirewallPolicy, FirewallSequence> |
|---|
Return FQN of application-policy-set in list form.
Return FQN of application-policy-set as colon delimited string.
Return global-vrouter-config list for application-policy-set.
| Returns: | list of <GlobalVrouterConfig> |
|---|
Return FQN of application-policy-set’s parent in list form.
Return FQN of application-policy-set’s parent as colon delimted string.
Return list of all projects using this application-policy-set
Return tag list for application-policy-set.
| Returns: | list of <Tag> |
|---|
Return object type (application-policy-set).
Get id-perms for application-policy-set.
| Returns: | IdPermsType object |
|---|
Get perms2 for application-policy-set.
| Returns: | PermType2 object |
|---|
Set firewall-policy for application-policy-set.
| Parameters: |
|
|---|
Set firewall-policy list for application-policy-set.
| Parameters: |
|
|---|
Set global-vrouter-config for application-policy-set.
| Parameters: | ref_obj – GlobalVrouterConfig object |
|---|
Set global-vrouter-config list for application-policy-set.
| Parameters: | ref_obj_list – list of GlobalVrouterConfig object |
|---|
Set tag for application-policy-set.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for application-policy-set.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
BGP as service object represents BGP peer in the virtual network that can participate in dynamic routing with implicit default gateway of the virtual network.
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.
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
Type: str, one-of xsd:string
Created By: User (required)
Operations Allowed: CRUD
Description:
Ip address of the BGP peer.
Type: BgpSessionAttributes
Created By: User (required)
Operations Allowed: CRUD
Description:
BGP peering session attributes.
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.
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.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to control-node-zone for bgp-peer selection
Created By: User (required)
Operations Allowed: CRUD
Description:
Reference to VMI on which BGPaaS BGP peering will happen.
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.
Created By: System
Operations Allowed: CRUD
Description:
Reference to internal BGP peer object automatically generated by the system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add bgp-router to bgp-as-a-service.
| Parameters: | ref_obj – BgpRouter object |
|---|
Add control-node-zone to bgp-as-a-service.
| Parameters: |
|
|---|
Add service-health-check to bgp-as-a-service.
| Parameters: | ref_obj – ServiceHealthCheck object |
|---|
Add tag to bgp-as-a-service.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-machine-interface to bgp-as-a-service.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Get annotations for bgp-as-a-service.
| Returns: | KeyValuePairs object |
|---|
Get autonomous-system for bgp-as-a-service.
| Returns: | AutonomousSystemType object |
|---|
Get bgpaas-ip-address for bgp-as-a-service.
| Returns: | IpAddressType object |
|---|
Get bgpaas-ipv4-mapped-ipv6-nexthop for bgp-as-a-service.
| Returns: | xsd:boolean object |
|---|
Get bgpaas-session-attributes for bgp-as-a-service.
| Returns: | BgpSessionAttributes object |
|---|
Get bgpaas-shared for bgp-as-a-service.
| Returns: | xsd:boolean object |
|---|
Get bgpaas-suppress-route-advertisement for bgp-as-a-service.
| Returns: | xsd:boolean object |
|---|
Get display-name for bgp-as-a-service.
| Returns: | xsd:string object |
|---|
Display bgp-as-a-service object in compact form.
Return bgp-router list for bgp-as-a-service.
| Returns: | list of <BgpRouter> |
|---|
Return control-node-zone list for bgp-as-a-service.
| Returns: | list of tuple <ControlNodeZone, BGPaaSControlNodeZoneAttributes> |
|---|
Return FQN of bgp-as-a-service in list form.
Return FQN of bgp-as-a-service as colon delimited string.
Return FQN of bgp-as-a-service’s parent in list form.
Return FQN of bgp-as-a-service’s parent as colon delimted string.
Return service-health-check list for bgp-as-a-service.
| Returns: | list of <ServiceHealthCheck> |
|---|
Return tag list for bgp-as-a-service.
| Returns: | list of <Tag> |
|---|
Return object type (bgp-as-a-service).
Return virtual-machine-interface list for bgp-as-a-service.
| Returns: | list of <VirtualMachineInterface> |
|---|
Get id-perms for bgp-as-a-service.
| Returns: | IdPermsType object |
|---|
Get perms2 for bgp-as-a-service.
| Returns: | PermType2 object |
|---|
Set bgp-router for bgp-as-a-service.
| Parameters: | ref_obj – BgpRouter object |
|---|
Set bgp-router list for bgp-as-a-service.
| Parameters: | ref_obj_list – list of BgpRouter object |
|---|
Set control-node-zone for bgp-as-a-service.
| Parameters: |
|
|---|
Set control-node-zone list for bgp-as-a-service.
| Parameters: |
|
|---|
Set service-health-check for bgp-as-a-service.
| Parameters: | ref_obj – ServiceHealthCheck object |
|---|
Set service-health-check list for bgp-as-a-service.
| Parameters: | ref_obj_list – list of ServiceHealthCheck object |
|---|
Set tag for bgp-as-a-service.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for bgp-as-a-service.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-machine-interface for bgp-as-a-service.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Set virtual-machine-interface list for bgp-as-a-service.
| Parameters: | ref_obj_list – list of VirtualMachineInterface object |
|---|
Bases: future.types.newobject.newobject
Type: BgpRouterParams
Created By: User (required)
Operations Allowed: CRUD
Description:
BGP router configuration parameters like ip address, AS number, hold time etc.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
This bgp-router belongs to the referenced control-node-zone.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference of bgp-router to sub-cluster .
Created By: User (optional)
Operations Allowed: CRUD
Description:
References to peer BGP router, property of the reference has BGP peering attributes.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add bgp-router to bgp-router.
| Parameters: |
|
|---|
Add control-node-zone to bgp-router.
| Parameters: | ref_obj – ControlNodeZone object |
|---|
Add sub-cluster to bgp-router.
| Parameters: | ref_obj – SubCluster object |
|---|
Add tag to bgp-router.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for bgp-router.
| Returns: | KeyValuePairs object |
|---|
Get bgp-router-parameters for bgp-router.
| Returns: | BgpRouterParams object |
|---|
Get display-name for bgp-router.
| Returns: | xsd:string object |
|---|
Display bgp-router object in compact form.
Return list of all bgp-as-a-services using this bgp-router
Return list of all bgp-routers using this bgp-router
Return bgp-router list for bgp-router.
| Returns: | list of tuple <BgpRouter, BgpPeeringAttributes> |
|---|
Return control-node-zone list for bgp-router.
| Returns: | list of <ControlNodeZone> |
|---|
Return FQN of bgp-router in list form.
Return FQN of bgp-router as colon delimited string.
Return list of all global-system-configs using this bgp-router
Return FQN of bgp-router’s parent in list form.
Return FQN of bgp-router’s parent as colon delimted string.
Return list of all physical-routers using this bgp-router
Return sub-cluster list for bgp-router.
| Returns: | list of <SubCluster> |
|---|
Return tag list for bgp-router.
| Returns: | list of <Tag> |
|---|
Return object type (bgp-router).
Return list of all virtual-machine-interfaces using this bgp-router
Get id-perms for bgp-router.
| Returns: | IdPermsType object |
|---|
Get perms2 for bgp-router.
| Returns: | PermType2 object |
|---|
Set bgp-router for bgp-router.
| Parameters: |
|
|---|
Set bgp-router list for bgp-router.
| Parameters: |
|
|---|
Set control-node-zone for bgp-router.
| Parameters: | ref_obj – ControlNodeZone object |
|---|
Set control-node-zone list for bgp-router.
| Parameters: | ref_obj_list – list of ControlNodeZone object |
|---|
Set sub-cluster for bgp-router.
| Parameters: | ref_obj – SubCluster object |
|---|
Set sub-cluster list for bgp-router.
| Parameters: | ref_obj_list – list of SubCluster object |
|---|
Set tag for bgp-router.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for bgp-router.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
BGP VPN resource contains a set of parameters for a BGP-based VPN
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.
Type: RouteTargetList
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of route targets that are used as import for this virtual network.
Type: RouteTargetList
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of route targets that are used as export for this virtual network.
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).
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to bgpvpn.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for bgpvpn.
| Returns: | KeyValuePairs object |
|---|
Get bgpvpn-type for bgpvpn.
| Returns: | VpnType object |
|---|
Get display-name for bgpvpn.
| Returns: | xsd:string object |
|---|
Display bgpvpn object in compact form.
Get export-route-target-list for bgpvpn.
| Returns: | RouteTargetList object |
|---|
Return FQN of bgpvpn in list form.
Return FQN of bgpvpn as colon delimited string.
Return list of all logical-routers using this bgpvpn
Return FQN of bgpvpn’s parent in list form.
Return FQN of bgpvpn’s parent as colon delimted string.
Return tag list for bgpvpn.
| Returns: | list of <Tag> |
|---|
Return object type (bgpvpn).
Return list of all virtual-networks using this bgpvpn
Get id-perms for bgpvpn.
| Returns: | IdPermsType object |
|---|
Get import-route-target-list for bgpvpn.
| Returns: | RouteTargetList object |
|---|
Get perms2 for bgpvpn.
| Returns: | PermType2 object |
|---|
Get route-target-list for bgpvpn.
| Returns: | RouteTargetList object |
|---|
Set tag for bgpvpn.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for bgpvpn.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
bridge-domains configured in a virtual network
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Enable MAC learning on the network
Type: MACLimitControlType
Created By: User (optional)
Operations Allowed: CRUD
Description:
MAC limit control on the network
Type: MACMoveLimitControlType
Created By: User (optional)
Operations Allowed: CRUD
Description:
MAC move control on the network
Type: int, within [0, 86400]
Created By: User (optional)
Operations Allowed: CRUD
Description:
MAC aging time on the network
Type: int, within [1, 16777215]
Created By: User (required)
Operations Allowed: CRUD
Description:
i-sid value
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to bridge-domain.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for bridge-domain.
| Returns: | KeyValuePairs object |
|---|
Get display-name for bridge-domain.
| Returns: | xsd:string object |
|---|
Display bridge-domain object in compact form.
Return FQN of bridge-domain in list form.
Return FQN of bridge-domain as colon delimited string.
Return FQN of bridge-domain’s parent in list form.
Return FQN of bridge-domain’s parent as colon delimted string.
Return tag list for bridge-domain.
| Returns: | list of <Tag> |
|---|
Return object type (bridge-domain).
Return list of all virtual-machine-interfaces using this bridge-domain
Get id-perms for bridge-domain.
| Returns: | IdPermsType object |
|---|
Get isid for bridge-domain.
| Returns: | IsidType object |
|---|
Get mac-aging-time for bridge-domain.
| Returns: | MACAgingTime object |
|---|
Get mac-learning-enabled for bridge-domain.
| Returns: | xsd:boolean object |
|---|
Get mac-limit-control for bridge-domain.
| Returns: | MACLimitControlType object |
|---|
Get mac-move-control for bridge-domain.
| Returns: | MACMoveLimitControlType object |
|---|
Get perms2 for bridge-domain.
| Returns: | PermType2 object |
|---|
Set tag for bridge-domain.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for bridge-domain.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
This resource contains the information about the interface card in a hardware platform.
Created By:
- Properties:
- interface_map
Type: InterfaceMapType
Created By: User (required)
Operations Allowed: CRUD
Description:
Interface map of all the physical ports on a physical interface card.
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
Add tag to card.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for card.
| Returns: | KeyValuePairs object |
|---|
Get display-name for card.
| Returns: | xsd:string object |
|---|
Display card object in compact form.
Return FQN of card in list form.
Return FQN of card as colon delimited string.
Return list of all hardwares using this card
Return tag list for card.
| Returns: | list of <Tag> |
|---|
Return object type (card).
Get id-perms for card.
| Returns: | IdPermsType object |
|---|
Get interface-map for card.
| Returns: | InterfaceMapType object |
|---|
Get perms2 for card.
| Returns: | PermType2 object |
|---|
Set tag for card.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for card.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
CLI commits done on a physical router.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Aggregated cli accepted configs. This config will be pushed when the device undergoes RMA along with
Contrail configuration
Type: CliDiffListType
Created By: User (optional)
Operations Allowed: CRUD
Description:
CLI diff object containing details about the commit such as username, time and the configuration
diff
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Get accepted-cli-config for cli-config.
| Returns: | xsd:string object |
|---|
Add tag to cli-config.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for cli-config.
| Returns: | KeyValuePairs object |
|---|
Get commit-diff-list for cli-config.
| Returns: | CliDiffListType object |
|---|
Get display-name for cli-config.
| Returns: | xsd:string object |
|---|
Display cli-config object in compact form.
Return FQN of cli-config in list form.
Return FQN of cli-config as colon delimited string.
Return FQN of cli-config’s parent in list form.
Return FQN of cli-config’s parent as colon delimted string.
Return tag list for cli-config.
| Returns: | list of <Tag> |
|---|
Return object type (cli-config).
Get id-perms for cli-config.
| Returns: | IdPermsType object |
|---|
Get perms2 for cli-config.
| Returns: | PermType2 object |
|---|
Set tag for cli-config.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for cli-config.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Config Database node is object representing a logical node in system which hosts Cassandra DB and Zookeeper for Config.
Type: str, one-of xsd:string
Created By: User (required)
Operations Allowed: CRUD
Description:
Ip address of the Config DB node, set while provisioning.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to config-database-node.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for config-database-node.
| Returns: | KeyValuePairs object |
|---|
Get config-database-node-ip-address for config-database-node.
| Returns: | IpAddressType object |
|---|
Get display-name for config-database-node.
| Returns: | xsd:string object |
|---|
Display config-database-node object in compact form.
Return FQN of config-database-node in list form.
Return FQN of config-database-node as colon delimited string.
Return FQN of config-database-node’s parent in list form.
Return FQN of config-database-node’s parent as colon delimted string.
Return tag list for config-database-node.
| Returns: | list of <Tag> |
|---|
Return object type (config-database-node).
Get id-perms for config-database-node.
| Returns: | IdPermsType object |
|---|
Get perms2 for config-database-node.
| Returns: | PermType2 object |
|---|
Set tag for config-database-node.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for config-database-node.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Config node is object representing a logical node in system which serves config API.
Type: str, one-of xsd:string
Created By: User (admin-only)
Operations Allowed: CRUD
Description:
Ip address of the config node, set while provisioning.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to config-node.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for config-node.
| Returns: | KeyValuePairs object |
|---|
Get config-node-ip-address for config-node.
| Returns: | IpAddressType object |
|---|
Get display-name for config-node.
| Returns: | xsd:string object |
|---|
Display config-node object in compact form.
Return FQN of config-node in list form.
Return FQN of config-node as colon delimited string.
Return FQN of config-node’s parent in list form.
Return FQN of config-node’s parent as colon delimted string.
Return tag list for config-node.
| Returns: | list of <Tag> |
|---|
Return object type (config-node).
Get id-perms for config-node.
| Returns: | IdPermsType object |
|---|
Get perms2 for config-node.
| Returns: | PermType2 object |
|---|
Set tag for config-node.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for config-node.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
List of config properties.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of Config properties
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to config-properties.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for config-properties.
| Returns: | KeyValuePairs object |
|---|
Get display-name for config-properties.
| Returns: | xsd:string object |
|---|
Display config-properties object in compact form.
Return FQN of config-properties in list form.
Return FQN of config-properties as colon delimited string.
Return FQN of config-properties’s parent in list form.
Return FQN of config-properties’s parent as colon delimted string.
Return tag list for config-properties.
| Returns: | list of <Tag> |
|---|
Return object type (config-properties).
Get id-perms for config-properties.
| Returns: | IdPermsType object |
|---|
Get perms2 for config-properties.
| Returns: | PermType2 object |
|---|
Get properties for config-properties.
| Returns: | KeyValuePairs object |
|---|
Set tag for config-properties.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for config-properties.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Created By:
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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.
Created By: User (required)
Operations Allowed: R
Description:
Global system config is object where all global system configuration is present.
Created By: System
Operations Allowed: CRUD
Description:
Domain is authentication namespace, a collection of projects.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Global level policy-management object re-grouping global policy resources.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Attribute attached to objects - has a type and value
Created By: User (optional)
Operations Allowed: CRUD
Description:
Attribute attached to objects - has a type and value
Referred by:
Add tag to config-root.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for config-root.
| Returns: | KeyValuePairs object |
|---|
Get display-name for config-root.
| Returns: | xsd:string object |
|---|
Display config-root object in compact form.
Return FQN of config-root in list form.
Return FQN of config-root as colon delimited string.
Return tag list for config-root.
| Returns: | list of <Tag> |
|---|
Return object type (config-root).
Get id-perms for config-root.
| Returns: | IdPermsType object |
|---|
Get perms2 for config-root.
| Returns: | PermType2 object |
|---|
Set tag for config-root.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for config-root.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
List of references to all control-node-zones in systems.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to control-node-zone.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for control-node-zone.
| Returns: | KeyValuePairs object |
|---|
Get display-name for control-node-zone.
| Returns: | xsd:string object |
|---|
Display control-node-zone object in compact form.
Return list of all bgp-as-a-services using this control-node-zone
Return list of all bgp-routers using this control-node-zone
Return FQN of control-node-zone in list form.
Return FQN of control-node-zone as colon delimited string.
Return FQN of control-node-zone’s parent in list form.
Return FQN of control-node-zone’s parent as colon delimted string.
Return tag list for control-node-zone.
| Returns: | list of <Tag> |
|---|
Return object type (control-node-zone).
Get id-perms for control-node-zone.
| Returns: | IdPermsType object |
|---|
Get perms2 for control-node-zone.
| Returns: | PermType2 object |
|---|
Set tag for control-node-zone.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for control-node-zone.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Created By:
Type: AttachmentAddressType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Not in Use.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Not in Use.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add floating-ip to customer-attachment.
| Parameters: | ref_obj – FloatingIp object |
|---|
Add tag to customer-attachment.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-machine-interface to customer-attachment.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Get annotations for customer-attachment.
| Returns: | KeyValuePairs object |
|---|
Get attachment-address for customer-attachment.
| Returns: | AttachmentAddressType object |
|---|
Get display-name for customer-attachment.
| Returns: | xsd:string object |
|---|
Display customer-attachment object in compact form.
Return floating-ip list for customer-attachment.
| Returns: | list of <FloatingIp> |
|---|
Return FQN of customer-attachment in list form.
Return FQN of customer-attachment as colon delimited string.
Return tag list for customer-attachment.
| Returns: | list of <Tag> |
|---|
Return object type (customer-attachment).
Return virtual-machine-interface list for customer-attachment.
| Returns: | list of <VirtualMachineInterface> |
|---|
Get id-perms for customer-attachment.
| Returns: | IdPermsType object |
|---|
Get perms2 for customer-attachment.
| Returns: | PermType2 object |
|---|
Set floating-ip for customer-attachment.
| Parameters: | ref_obj – FloatingIp object |
|---|
Set floating-ip list for customer-attachment.
| Parameters: | ref_obj_list – list of FloatingIp object |
|---|
Set tag for customer-attachment.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for customer-attachment.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-machine-interface for customer-attachment.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Set virtual-machine-interface list for customer-attachment.
| Parameters: | ref_obj_list – list of VirtualMachineInterface object |
|---|
Bases: future.types.newobject.newobject
List of DCI Objects in the system. Each DCI represents an interconnect of Multiple Fabrics or interconnect of LRs in same fabric.
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.
Type: str, one-of [u’l3’, u’l2’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Data Center InterConnect modes can be l2 or l3.
l2 - DCI mode l2 stretch.
l3 - DCI mode l3 stretch.
Type: AddressFamilies
Created By: User (optional)
Operations Allowed: CRUD
Description:
BGP address families supported by BGP router.
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.
Type: str, one-of [u’inter_fabric’, u’intra_fabric’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Defines type of DCI, inter-fabric is across two fabric. intra-fabric is single fabric.
Type: LogicalRouterPRListType
Created By: User (optional)
Operations Allowed: CRUD
Description:
holds List of physical router uuid of destination LR(s) in intra-fabric type DCI object
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
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
Created By: User (optional)
Operations Allowed: CRUD
Description:
reference to auto created internal virtual network, used for connecting different data centers for
DCI type inter-fabric and intra-fabric. For intra-fabric type DCI, if user does not provided any
DCI-routing-policy then this refs holds list of tenant virtual networks refs provided and selected
by users. this refs will be list of tenant VN which existed in source LR for intra-fabric type DCI.
routes will be leak only for this list of VNs subnets in intra-fabric DCI.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Used only if DCI-type is intra-fabric. it stores the List of routing policies for this DCI to be
used as import policies between logical routers. if any single or more routing policy defined in
this property then DCI-virtual-network-refs property value will be ignored for route leaks route-
filter.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to fabric, this link enables to identify which fabric this DCI belongs to. This refs used
for l2 mode inter-fabric dci
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add fabric to data-center-interconnect.
| Parameters: | ref_obj – Fabric object |
|---|
Add logical-router to data-center-interconnect.
| Parameters: | ref_obj – LogicalRouter object |
|---|
Add routing-policy to data-center-interconnect.
| Parameters: | ref_obj – RoutingPolicy object |
|---|
Add tag to data-center-interconnect.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-network to data-center-interconnect.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Get annotations for data-center-interconnect.
| Returns: | KeyValuePairs object |
|---|
Get data-center-interconnect-bgp-address-families for data-center-interconnect.
| Returns: | AddressFamilies object |
|---|
Get data-center-interconnect-bgp-hold-time for data-center-interconnect.
| Returns: | BgpHoldTime object |
|---|
Get data-center-interconnect-configured-route-target-list for data-center-interconnect.
| Returns: | RouteTargetList object |
|---|
Get data-center-interconnect-mode for data-center-interconnect.
| Returns: | DataCenterInterconnectModes object |
|---|
Get data-center-interconnect-type for data-center-interconnect.
| Returns: | DataCenterInterConnectType object |
|---|
Get destination-physical-router-list for data-center-interconnect.
| Returns: | LogicalRouterPRListType object |
|---|
Get display-name for data-center-interconnect.
| Returns: | xsd:string object |
|---|
Display data-center-interconnect object in compact form.
Return fabric list for data-center-interconnect.
| Returns: | list of <Fabric> |
|---|
Return FQN of data-center-interconnect in list form.
Return FQN of data-center-interconnect as colon delimited string.
Return logical-router list for data-center-interconnect.
| Returns: | list of <LogicalRouter> |
|---|
Return FQN of data-center-interconnect’s parent in list form.
Return FQN of data-center-interconnect’s parent as colon delimted string.
Return routing-policy list for data-center-interconnect.
| Returns: | list of <RoutingPolicy> |
|---|
Return tag list for data-center-interconnect.
| Returns: | list of <Tag> |
|---|
Return object type (data-center-interconnect).
Return virtual-network list for data-center-interconnect.
| Returns: | list of <VirtualNetwork> |
|---|
Get id-perms for data-center-interconnect.
| Returns: | IdPermsType object |
|---|
Get perms2 for data-center-interconnect.
| Returns: | PermType2 object |
|---|
Set fabric for data-center-interconnect.
| Parameters: | ref_obj – Fabric object |
|---|
Set fabric list for data-center-interconnect.
| Parameters: | ref_obj_list – list of Fabric object |
|---|
Set logical-router for data-center-interconnect.
| Parameters: | ref_obj – LogicalRouter object |
|---|
Set logical-router list for data-center-interconnect.
| Parameters: | ref_obj_list – list of LogicalRouter object |
|---|
Set routing-policy for data-center-interconnect.
| Parameters: | ref_obj – RoutingPolicy object |
|---|
Set routing-policy list for data-center-interconnect.
| Parameters: | ref_obj_list – list of RoutingPolicy object |
|---|
Set tag for data-center-interconnect.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for data-center-interconnect.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-network for data-center-interconnect.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Set virtual-network list for data-center-interconnect.
| Parameters: | ref_obj_list – list of VirtualNetwork object |
|---|
Bases: future.types.newobject.newobject
Database node is object representing a logical node in system which host Cassandra DB and Zookeeper.
Type: str, one-of xsd:string
Created By: User (required)
Operations Allowed: CRUD
Description:
Ip address of the database node, set while provisioning.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to database-node.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for database-node.
| Returns: | KeyValuePairs object |
|---|
Get database-node-ip-address for database-node.
| Returns: | IpAddressType object |
|---|
Get display-name for database-node.
| Returns: | xsd:string object |
|---|
Display database-node object in compact form.
Return FQN of database-node in list form.
Return FQN of database-node as colon delimited string.
Return FQN of database-node’s parent in list form.
Return FQN of database-node’s parent as colon delimted string.
Return tag list for database-node.
| Returns: | list of <Tag> |
|---|
Return object type (database-node).
Get id-perms for database-node.
| Returns: | IdPermsType object |
|---|
Get perms2 for database-node.
| Returns: | PermType2 object |
|---|
Set tag for database-node.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for database-node.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
This resource contains information about the device chassis. The PR can refer to this object for chassis details. This resource name must follow the convention: ‘vendorname_chassismac’ (replacing mac ‘:’ with ‘_’), for example, ‘juniper_00_11_22_33_44_55’
Created By:
- Properties:
- device_chassis_type
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
type of the chassis address if known.
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
- Referred by:
- list of PhysicalRouter objects
Add tag to device-chassis.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for device-chassis.
| Returns: | KeyValuePairs object |
|---|
Get device-chassis-type for device-chassis.
| Returns: | xsd:string object |
|---|
Get display-name for device-chassis.
| Returns: | xsd:string object |
|---|
Display device-chassis object in compact form.
Return FQN of device-chassis in list form.
Return FQN of device-chassis as colon delimited string.
Return list of all physical-routers using this device-chassis
Return tag list for device-chassis.
| Returns: | list of <Tag> |
|---|
Return object type (device-chassis).
Get id-perms for device-chassis.
| Returns: | IdPermsType object |
|---|
Get perms2 for device-chassis.
| Returns: | PermType2 object |
|---|
Set tag for device-chassis.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for device-chassis.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Device functional group is used to group together any selected list of devices for the purpose of assigning identical attributes. For example, os-version, physical-roles, rb-roles
- Created By:
- User
- Child of:
- Project object
- Properties:
- device_functional_group_description
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Description of the functional group stating the functionality the devices would get if assigned to
this group
- device_functional_group_os_version
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
OS version for devices in this group. If set, it is the first choice for device image upgrade during
ztp. If not set, fabric-os-version is used
- device_functional_group_routing_bridging_roles
Type: RoutingBridgingRolesType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Routing-bridging role (e.g. CRB, ERB, etc.), used by the device manager to provision physical
router, for e.g device manager may choose to configure physical router based on its role.
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of PhysicalRole objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Physical role assigned to all physical routers which are members of this device functional group
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
- Referred by:
- list of PhysicalRouter objects
Add physical-role to device-functional-group.
| Parameters: | ref_obj – PhysicalRole object |
|---|
Add tag to device-functional-group.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for device-functional-group.
| Returns: | KeyValuePairs object |
|---|
Get device-functional-group-description for device-functional-group.
| Returns: | xsd:string object |
|---|
Get device-functional-group-os-version for device-functional-group.
| Returns: | xsd:string object |
|---|
Get device-functional-group-routing-bridging-roles for device-functional-group.
| Returns: | RoutingBridgingRolesType object |
|---|
Get display-name for device-functional-group.
| Returns: | xsd:string object |
|---|
Display device-functional-group object in compact form.
Return FQN of device-functional-group in list form.
Return FQN of device-functional-group as colon delimited string.
Return FQN of device-functional-group’s parent in list form.
Return FQN of device-functional-group’s parent as colon delimted string.
Return physical-role list for device-functional-group.
| Returns: | list of <PhysicalRole> |
|---|
Return list of all physical-routers using this device-functional-group
Return tag list for device-functional-group.
| Returns: | list of <Tag> |
|---|
Return object type (device-functional-group).
Get id-perms for device-functional-group.
| Returns: | IdPermsType object |
|---|
Get perms2 for device-functional-group.
| Returns: | PermType2 object |
|---|
Set physical-role for device-functional-group.
| Parameters: | ref_obj – PhysicalRole object |
|---|
Set physical-role list for device-functional-group.
| Parameters: | ref_obj_list – list of PhysicalRole object |
|---|
Set tag for device-functional-group.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for device-functional-group.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
list of device image info for the images that get uploaded to the system.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Name of the device image. As of now, for Juniper devices, it will be used by device manager during
image upgrade to send additional flag for vmhost based REs.
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
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
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
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
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
file uri for the device image uploaded to the image server.
Type: int
Created By: User (optional)
Operations Allowed: CRUD
Description:
file size of the device image that was uploaded to the image server.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
md5 checksum of the image file that was uploaded to the image server.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
sha1 checksum of the image file that was uploaded to the image server.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Add hardware to device-image.
| Parameters: | ref_obj – Hardware object |
|---|
Add tag to device-image.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for device-image.
| Returns: | KeyValuePairs object |
|---|
Get device-image-device-family for device-image.
| Returns: | xsd:string object |
|---|
Get device-image-file-name for device-image.
| Returns: | xsd:string object |
|---|
Get device-image-file-uri for device-image.
| Returns: | xsd:string object |
|---|
Get device-image-md5 for device-image.
| Returns: | xsd:string object |
|---|
Get device-image-os-version for device-image.
| Returns: | xsd:string object |
|---|
Get device-image-sha1 for device-image.
| Returns: | xsd:string object |
|---|
Get device-image-size for device-image.
| Returns: | xsd:integer object |
|---|
Get device-image-supported-platforms for device-image.
| Returns: | DevicePlatformListType object |
|---|
Get device-image-vendor-name for device-image.
| Returns: | xsd:string object |
|---|
Get display-name for device-image.
| Returns: | xsd:string object |
|---|
Display device-image object in compact form.
Return FQN of device-image in list form.
Return FQN of device-image as colon delimited string.
Return hardware list for device-image.
| Returns: | list of <Hardware> |
|---|
Return FQN of device-image’s parent in list form.
Return FQN of device-image’s parent as colon delimted string.
Return list of all physical-routers using this device-image
Return tag list for device-image.
| Returns: | list of <Tag> |
|---|
Return object type (device-image).
Get id-perms for device-image.
| Returns: | IdPermsType object |
|---|
Get perms2 for device-image.
| Returns: | PermType2 object |
|---|
Set hardware for device-image.
| Parameters: | ref_obj – Hardware object |
|---|
Set hardware list for device-image.
| Parameters: | ref_obj_list – list of Hardware object |
|---|
Set tag for device-image.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for device-image.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
devicemgr node is object representing a logical node in system for configuring physical devices.
Type: str, one-of xsd:string
Created By: User (admin-only)
Operations Allowed: CRUD
Description:
Ip address of the devicemgr node, set while provisioning.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to devicemgr-node.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for devicemgr-node.
| Returns: | KeyValuePairs object |
|---|
Get devicemgr-node-ip-address for devicemgr-node.
| Returns: | IpAddressType object |
|---|
Get display-name for devicemgr-node.
| Returns: | xsd:string object |
|---|
Display devicemgr-node object in compact form.
Return FQN of devicemgr-node in list form.
Return FQN of devicemgr-node as colon delimited string.
Return FQN of devicemgr-node’s parent in list form.
Return FQN of devicemgr-node’s parent as colon delimted string.
Return tag list for devicemgr-node.
| Returns: | list of <Tag> |
|---|
Return object type (devicemgr-node).
Get id-perms for devicemgr-node.
| Returns: | IdPermsType object |
|---|
Get perms2 for devicemgr-node.
| Returns: | PermType2 object |
|---|
Set tag for devicemgr-node.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for devicemgr-node.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Created By:
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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.
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).
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to discovery-service-assignment.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for discovery-service-assignment.
| Returns: | KeyValuePairs object |
|---|
Get display-name for discovery-service-assignment.
| Returns: | xsd:string object |
|---|
Display discovery-service-assignment object in compact form.
Return FQN of discovery-service-assignment in list form.
Return FQN of discovery-service-assignment as colon delimited string.
Return tag list for discovery-service-assignment.
| Returns: | list of <Tag> |
|---|
Return object type (discovery-service-assignment).
Get id-perms for discovery-service-assignment.
| Returns: | IdPermsType object |
|---|
Get perms2 for discovery-service-assignment.
| Returns: | PermType2 object |
|---|
Set tag for discovery-service-assignment.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for discovery-service-assignment.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Domain is authentication namespace, a collection of projects.
Type: DomainLimitsType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Domain level quota, not currently implemented
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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.
Created By: System
Operations Allowed: CRUD
Description:
Project represent one instance of application or tenant.
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.
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.
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.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to domain.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for domain.
| Returns: | KeyValuePairs object |
|---|
Get display-name for domain.
| Returns: | xsd:string object |
|---|
Get domain-limits for domain.
| Returns: | DomainLimitsType object |
|---|
Display domain object in compact form.
Return FQN of domain in list form.
Return FQN of domain as colon delimited string.
Return FQN of domain’s parent in list form.
Return FQN of domain’s parent as colon delimted string.
Return tag list for domain.
| Returns: | list of <Tag> |
|---|
Return object type (domain).
Get id-perms for domain.
| Returns: | IdPermsType object |
|---|
Get perms2 for domain.
| Returns: | PermType2 object |
|---|
Set tag for domain.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for domain.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Discovery service rule for assigning subscriber to publisher. (set of subscriber) can be assigned to (set of publisher).
Type: DiscoveryServiceAssignmentType
Created By: User (required)
Operations Allowed: CRUD
Description:
rule entry defining publisher set and subscriber set.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to dsa-rule.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for dsa-rule.
| Returns: | KeyValuePairs object |
|---|
Get display-name for dsa-rule.
| Returns: | xsd:string object |
|---|
Get dsa-rule-entry for dsa-rule.
| Returns: | DiscoveryServiceAssignmentType object |
|---|
Display dsa-rule object in compact form.
Return FQN of dsa-rule in list form.
Return FQN of dsa-rule as colon delimited string.
Return FQN of dsa-rule’s parent in list form.
Return FQN of dsa-rule’s parent as colon delimted string.
Return tag list for dsa-rule.
| Returns: | list of <Tag> |
|---|
Return object type (dsa-rule).
Get id-perms for dsa-rule.
| Returns: | IdPermsType object |
|---|
Get perms2 for dsa-rule.
| Returns: | PermType2 object |
|---|
Set tag for dsa-rule.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for dsa-rule.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Created By:
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
This service provider is connected to all other service providers.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Links the service provider to a peering policy.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Links the service provider to peer routers.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add peering-policy to e2-service-provider.
| Parameters: | ref_obj – PeeringPolicy object |
|---|
Add physical-router to e2-service-provider.
| Parameters: | ref_obj – PhysicalRouter object |
|---|
Add tag to e2-service-provider.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for e2-service-provider.
| Returns: | KeyValuePairs object |
|---|
Get display-name for e2-service-provider.
| Returns: | xsd:string object |
|---|
Display e2-service-provider object in compact form.
Get e2-service-provider-promiscuous for e2-service-provider.
| Returns: | xsd:boolean object |
|---|
Return FQN of e2-service-provider in list form.
Return FQN of e2-service-provider as colon delimited string.
Return peering-policy list for e2-service-provider.
| Returns: | list of <PeeringPolicy> |
|---|
Return physical-router list for e2-service-provider.
| Returns: | list of <PhysicalRouter> |
|---|
Return tag list for e2-service-provider.
| Returns: | list of <Tag> |
|---|
Return object type (e2-service-provider).
Get id-perms for e2-service-provider.
| Returns: | IdPermsType object |
|---|
Get perms2 for e2-service-provider.
| Returns: | PermType2 object |
|---|
Set peering-policy for e2-service-provider.
| Parameters: | ref_obj – PeeringPolicy object |
|---|
Set peering-policy list for e2-service-provider.
| Parameters: | ref_obj_list – list of PeeringPolicy object |
|---|
Set physical-router for e2-service-provider.
| Parameters: | ref_obj – PhysicalRouter object |
|---|
Set physical-router list for e2-service-provider.
| Parameters: | ref_obj_list – list of PhysicalRouter object |
|---|
Set tag for e2-service-provider.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for e2-service-provider.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
List of fabrics in the system. Each fabric is an administrative domain for all the network devices in one or multiple CLOS.
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.
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.
Type: DeviceCredentialList
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of device credentials to manage the network devices in the fabric.
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.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
This attribute indicates whether complex validations for VLAN-VN uniqueness check should be done for
enterprise style VPGs in the fabric. Default behaviour is to enable all the validations.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of virtual port groups in this fabric.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Fabric that belongs to this intent map
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.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add intent-map to fabric.
| Parameters: | ref_obj – IntentMap object |
|---|
Add node-profile to fabric.
| Parameters: |
|
|---|
Add tag to fabric.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-network to fabric.
| Parameters: |
|
|---|
Get annotations for fabric.
| Returns: | KeyValuePairs object |
|---|
Get disable-vlan-vn-uniqueness-check for fabric.
| Returns: | xsd:boolean object |
|---|
Get display-name for fabric.
| Returns: | xsd:string object |
|---|
Display fabric object in compact form.
Get fabric-credentials for fabric.
| Returns: | DeviceCredentialList object |
|---|
Get fabric-enterprise-style for fabric.
| Returns: | xsd:boolean object |
|---|
Get fabric-os-version for fabric.
| Returns: | xsd:string object |
|---|
Get fabric-ztp for fabric.
| Returns: | xsd:boolean object |
|---|
Return list of all data-center-interconnects using this fabric
Return FQN of fabric in list form.
Return FQN of fabric as colon delimited string.
Return intent-map list for fabric.
| Returns: | list of <IntentMap> |
|---|
Return list of all logical-routers using this fabric
Return node-profile list for fabric.
| Returns: | list of tuple <NodeProfile, SerialNumListType> |
|---|
Return FQN of fabric’s parent in list form.
Return FQN of fabric’s parent as colon delimted string.
Return list of all physical-routers using this fabric
Return tag list for fabric.
| Returns: | list of <Tag> |
|---|
Return object type (fabric).
Return virtual-network list for fabric.
| Returns: | list of tuple <VirtualNetwork, FabricNetworkTag> |
|---|
Get id-perms for fabric.
| Returns: | IdPermsType object |
|---|
Get perms2 for fabric.
| Returns: | PermType2 object |
|---|
Set intent-map for fabric.
| Parameters: | ref_obj – IntentMap object |
|---|
Set intent-map list for fabric.
| Parameters: | ref_obj_list – list of IntentMap object |
|---|
Set node-profile for fabric.
| Parameters: |
|
|---|
Set node-profile list for fabric.
| Parameters: |
|
|---|
Set tag for fabric.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for fabric.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-network for fabric.
| Parameters: |
|
|---|
Set virtual-network list for fabric.
| Parameters: |
|
|---|
Bases: future.types.newobject.newobject
list of fabric namespaces that define a set of resources that can be used to configure the network devices in the fabric.
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
Type: NamespaceValue
Created By: User (optional)
Operations Allowed: CRUD
Description:
namespace value of type defined by the namespace-type.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to fabric-namespace.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for fabric-namespace.
| Returns: | KeyValuePairs object |
|---|
Get display-name for fabric-namespace.
| Returns: | xsd:string object |
|---|
Display fabric-namespace object in compact form.
Get fabric-namespace-type for fabric-namespace.
| Returns: | NamespaceType object |
|---|
Get fabric-namespace-value for fabric-namespace.
| Returns: | NamespaceValue object |
|---|
Return FQN of fabric-namespace in list form.
Return FQN of fabric-namespace as colon delimited string.
Return FQN of fabric-namespace’s parent in list form.
Return FQN of fabric-namespace’s parent as colon delimted string.
Return tag list for fabric-namespace.
| Returns: | list of <Tag> |
|---|
Return object type (fabric-namespace).
Get id-perms for fabric-namespace.
| Returns: | IdPermsType object |
|---|
Get perms2 for fabric-namespace.
| Returns: | PermType2 object |
|---|
Set tag for fabric-namespace.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for fabric-namespace.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
A granual networking feature supported by Fabric Manager
- Created By:
- User
- Child of:
- GlobalSystemConfig object
- Properties:
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- Referred by:
- list of Feature objects
- list of RoleDefinition objects
Add feature to feature.
| Parameters: | ref_obj – Feature object |
|---|
Add tag to feature.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for feature.
| Returns: | KeyValuePairs object |
|---|
Get display-name for feature.
| Returns: | xsd:string object |
|---|
Display feature object in compact form.
Return list of all features using this feature
Return feature list for feature.
| Returns: | list of <Feature> |
|---|
Return FQN of feature in list form.
Return FQN of feature as colon delimited string.
Return FQN of feature’s parent in list form.
Return FQN of feature’s parent as colon delimted string.
Return list of all role-definitions using this feature
Return tag list for feature.
| Returns: | list of <Tag> |
|---|
Return object type (feature).
Get id-perms for feature.
| Returns: | IdPermsType object |
|---|
Get perms2 for feature.
| Returns: | PermType2 object |
|---|
Set feature for feature.
| Parameters: | ref_obj – Feature object |
|---|
Set feature list for feature.
| Parameters: | ref_obj_list – list of Feature object |
|---|
Set tag for feature.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for feature.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Vendor specific and/or feature specific configuration parameters editable by the user
- Created By:
- User
- Child of:
- RoleDefinition object
- Properties:
- feature_config_additional_params
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Additional configuration parameters for the feature.
- feature_config_vendor_config
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Vendor specific configuration/parameters for the feature.
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to feature-config.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for feature-config.
| Returns: | KeyValuePairs object |
|---|
Get display-name for feature-config.
| Returns: | xsd:string object |
|---|
Display feature-config object in compact form.
Get feature-config-additional-params for feature-config.
| Returns: | KeyValuePairs object |
|---|
Get feature-config-vendor-config for feature-config.
| Returns: | KeyValuePairs object |
|---|
Return FQN of feature-config in list form.
Return FQN of feature-config as colon delimited string.
Return FQN of feature-config’s parent in list form.
Return FQN of feature-config’s parent as colon delimted string.
Return tag list for feature-config.
| Returns: | list of <Tag> |
|---|
Return object type (feature-config).
Get id-perms for feature-config.
| Returns: | IdPermsType object |
|---|
Get perms2 for feature-config.
| Returns: | PermType2 object |
|---|
Set tag for feature-config.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for feature-config.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Feature Flag to swtich on/off the allowed feature
- Created By:
- User
- Child of:
- GlobalSystemConfig object
- Properties:
- feature_description
Type: str
Created By: System
Operations Allowed: R
Description:
short explanation about the feature.
- feature_id
Type: str, one-of [u’default’, u’__test_feature_1__’, u’__test_feature_2__’]
Created By: User (required)
Operations Allowed: CRUD
Description:
identifier for this feature
- feature_flag_version
Type: str
Created By: User (required)
Operations Allowed: CRUD
Description:
contrail release in which this feature flag is created.
- feature_release
Type: str
Created By: System
Operations Allowed: R
Description:
version of release in which the feature is introduced.
- enable_feature
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
knob to enable or disable an allowed feature.
- feature_state
Type: str, one-of [u’experimental’, u’alpha’, u’beta’, u’in-progress’, u’pre-retired’]
Created By: System
Operations Allowed: R
Description:
state of the feature
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to feature-flag.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for feature-flag.
| Returns: | KeyValuePairs object |
|---|
Get display-name for feature-flag.
| Returns: | xsd:string object |
|---|
Display feature-flag object in compact form.
Get enable-feature for feature-flag.
| Returns: | xsd:boolean object |
|---|
Get feature-description for feature-flag.
| Returns: | xsd:string object |
|---|
Get feature-flag-version for feature-flag.
| Returns: | xsd:string object |
|---|
Get feature-id for feature-flag.
| Returns: | FeatureIdType object |
|---|
Get feature-release for feature-flag.
| Returns: | xsd:string object |
|---|
Get feature-state for feature-flag.
| Returns: | FeatureStateType object |
|---|
Return FQN of feature-flag in list form.
Return FQN of feature-flag as colon delimited string.
Return FQN of feature-flag’s parent in list form.
Return FQN of feature-flag’s parent as colon delimted string.
Return tag list for feature-flag.
| Returns: | list of <Tag> |
|---|
Return object type (feature-flag).
Get id-perms for feature-flag.
| Returns: | IdPermsType object |
|---|
Get perms2 for feature-flag.
| Returns: | PermType2 object |
|---|
Set tag for feature-flag.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for feature-flag.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Type: str, one-of [u’created’, u’updated’, u’deleted’]
Created By: User (optional)
Operations Allowed: R
Description:
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to firewall-rule attached to this firewall-policy
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to security-logging-object attached to this firewall-policy
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add firewall-rule to firewall-policy.
| Parameters: |
|
|---|
Add security-logging-object to firewall-policy.
| Parameters: |
|
|---|
Add tag to firewall-policy.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for firewall-policy.
| Returns: | KeyValuePairs object |
|---|
Get display-name for firewall-policy.
| Returns: | xsd:string object |
|---|
Get draft-mode-state for firewall-policy.
| Returns: | DraftModeState object |
|---|
Display firewall-policy object in compact form.
Return list of all application-policy-sets using this firewall-policy
Return firewall-rule list for firewall-policy.
| Returns: | list of tuple <FirewallRule, FirewallSequence> |
|---|
Return FQN of firewall-policy in list form.
Return FQN of firewall-policy as colon delimited string.
Return FQN of firewall-policy’s parent in list form.
Return FQN of firewall-policy’s parent as colon delimted string.
Return security-logging-object list for firewall-policy.
| Returns: | list of tuple <SecurityLoggingObject, SloRateType> |
|---|
Return tag list for firewall-policy.
| Returns: | list of <Tag> |
|---|
Return object type (firewall-policy).
Get id-perms for firewall-policy.
| Returns: | IdPermsType object |
|---|
Get perms2 for firewall-policy.
| Returns: | PermType2 object |
|---|
Set firewall-rule for firewall-policy.
| Parameters: |
|
|---|
Set firewall-rule list for firewall-policy.
| Parameters: |
|
|---|
Set security-logging-object for firewall-policy.
| Parameters: |
|
|---|
Set security-logging-object list for firewall-policy.
| Parameters: |
|
|---|
Set tag for firewall-policy.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for firewall-policy.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Type: str, one-of [u’created’, u’updated’, u’deleted’]
Created By: User (optional)
Operations Allowed: R
Description:
Type: ActionListType
Created By: User (required)
Operations Allowed: CRUD
Description:
Actions to be performed if packets match condition
Type: FirewallServiceType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Service (port, protocol) for packets match condition
Type: FirewallRuleEndpointType
Created By: User (required)
Operations Allowed: CRUD
Description:
match condition for traffic source
Type: FirewallRuleEndpointType
Created By: User (required)
Operations Allowed: CRUD
Description:
match condition for traffic destination
Type: FirewallRuleMatchTagsType
Created By: User (required)
Operations Allowed: CRUD
Description:
matching tags for source and destination endpoints
Type: FirewallRuleMatchTagsTypeIdList
Created By: User (required)
Operations Allowed: R
Description:
matching tags ids for source and destination endpoints
Type: str, one-of [u’<’, u’>’, u’<>’]
Created By: User (required)
Operations Allowed: CRUD
Description:
Direction in the rule
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to service-group attached to this firewall policy
Created By: User (optional)
Operations Allowed: R
Description:
Reference to address group attached to endpoints
Created By: User (optional)
Operations Allowed: R
Description:
Reference to virtual network attached to endpoints
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to security-logging-object attached to this firewall-rule
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Get action-list for firewall-rule.
| Returns: | ActionListType object |
|---|
Add address-group to firewall-rule.
| Parameters: | ref_obj – AddressGroup object |
|---|
Add security-logging-object to firewall-rule.
| Parameters: |
|
|---|
Add service-group to firewall-rule.
| Parameters: | ref_obj – ServiceGroup object |
|---|
Add tag to firewall-rule.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-network to firewall-rule.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Get annotations for firewall-rule.
| Returns: | KeyValuePairs object |
|---|
Get direction for firewall-rule.
| Returns: | FirewallRuleDirectionType object |
|---|
Get display-name for firewall-rule.
| Returns: | xsd:string object |
|---|
Get draft-mode-state for firewall-rule.
| Returns: | DraftModeState object |
|---|
Display firewall-rule object in compact form.
Get endpoint-1 for firewall-rule.
| Returns: | FirewallRuleEndpointType object |
|---|
Get endpoint-2 for firewall-rule.
| Returns: | FirewallRuleEndpointType object |
|---|
Return address-group list for firewall-rule.
| Returns: | list of <AddressGroup> |
|---|
Return list of all firewall-policys using this firewall-rule
Return FQN of firewall-rule in list form.
Return FQN of firewall-rule as colon delimited string.
Return FQN of firewall-rule’s parent in list form.
Return FQN of firewall-rule’s parent as colon delimted string.
Return security-logging-object list for firewall-rule.
| Returns: | list of tuple <SecurityLoggingObject, SloRateType> |
|---|
Return service-group list for firewall-rule.
| Returns: | list of <ServiceGroup> |
|---|
Return tag list for firewall-rule.
| Returns: | list of <Tag> |
|---|
Return object type (firewall-rule).
Return virtual-network list for firewall-rule.
| Returns: | list of <VirtualNetwork> |
|---|
Get id-perms for firewall-rule.
| Returns: | IdPermsType object |
|---|
Get match-tag-types for firewall-rule.
| Returns: | FirewallRuleMatchTagsTypeIdList object |
|---|
Get match-tags for firewall-rule.
| Returns: | FirewallRuleMatchTagsType object |
|---|
Get perms2 for firewall-rule.
| Returns: | PermType2 object |
|---|
Get service for firewall-rule.
| Returns: | FirewallServiceType object |
|---|
Set address-group for firewall-rule.
| Parameters: | ref_obj – AddressGroup object |
|---|
Set address-group list for firewall-rule.
| Parameters: | ref_obj_list – list of AddressGroup object |
|---|
Set security-logging-object for firewall-rule.
| Parameters: |
|
|---|
Set security-logging-object list for firewall-rule.
| Parameters: |
|
|---|
Set service-group for firewall-rule.
| Parameters: | ref_obj – ServiceGroup object |
|---|
Set service-group list for firewall-rule.
| Parameters: | ref_obj_list – list of ServiceGroup object |
|---|
Set tag for firewall-rule.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for firewall-rule.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-network for firewall-rule.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Set virtual-network list for firewall-rule.
| Parameters: | ref_obj_list – list of VirtualNetwork object |
|---|
Bases: future.types.newobject.newobject
Type: str, one-of xsd:string
Created By: User (required)
Operations Allowed: CR
Description:
Floating ip address.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
This floating ip is used as virtual ip (VIP) in case of LBaaS.
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.
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
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.
Type: PortMappings
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of PortMaps for this floating-ip.
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
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (required)
Operations Allowed: CRUD
Description:
Reference to project is which this floating ip was allocated.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to virtual machine interface to which this floating ip is attached.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add project to floating-ip.
| Parameters: | ref_obj – Project object |
|---|
Add tag to floating-ip.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-machine-interface to floating-ip.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Get annotations for floating-ip.
| Returns: | KeyValuePairs object |
|---|
Get display-name for floating-ip.
| Returns: | xsd:string object |
|---|
Display floating-ip object in compact form.
Get floating-ip-address for floating-ip.
| Returns: | IpAddressType object |
|---|
Get floating-ip-address-family for floating-ip.
| Returns: | IpAddressFamilyType object |
|---|
Get floating-ip-fixed-ip-address for floating-ip.
| Returns: | IpAddressType object |
|---|
Get floating-ip-is-virtual-ip for floating-ip.
| Returns: | xsd:boolean object |
|---|
Get floating-ip-port-mappings for floating-ip.
| Returns: | PortMappings object |
|---|
Get floating-ip-port-mappings-enable for floating-ip.
| Returns: | xsd:boolean object |
|---|
Get floating-ip-traffic-direction for floating-ip.
| Returns: | TrafficDirectionType object |
|---|
Return list of all customer-attachments using this floating-ip
Return FQN of floating-ip in list form.
Return FQN of floating-ip as colon delimited string.
Return FQN of floating-ip’s parent in list form.
Return FQN of floating-ip’s parent as colon delimted string.
Return project list for floating-ip.
| Returns: | list of <Project> |
|---|
Return tag list for floating-ip.
| Returns: | list of <Tag> |
|---|
Return object type (floating-ip).
Return virtual-machine-interface list for floating-ip.
| Returns: | list of <VirtualMachineInterface> |
|---|
Get id-perms for floating-ip.
| Returns: | IdPermsType object |
|---|
Get perms2 for floating-ip.
| Returns: | PermType2 object |
|---|
Set project for floating-ip.
| Parameters: | ref_obj – Project object |
|---|
Set project list for floating-ip.
| Parameters: | ref_obj_list – list of Project object |
|---|
Set tag for floating-ip.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for floating-ip.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-machine-interface for floating-ip.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Set virtual-machine-interface list for floating-ip.
| Parameters: | ref_obj_list – list of VirtualMachineInterface object |
|---|
Bases: future.types.newobject.newobject
Floating ip pool is set of ip address that are carved out of a given network. Ip(s) from this set can be assigned to (virtual machine interface, ip) so that they become members of this network using one:one NAT.
Type: FloatingIpPoolSubnetType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Subnets that restrict floating ip allocation from the corresponding virtual network.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to floating-ip-pool.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for floating-ip-pool.
| Returns: | KeyValuePairs object |
|---|
Get display-name for floating-ip-pool.
| Returns: | xsd:string object |
|---|
Display floating-ip-pool object in compact form.
Get floating-ip-pool-subnets for floating-ip-pool.
| Returns: | FloatingIpPoolSubnetType object |
|---|
Return FQN of floating-ip-pool in list form.
Return FQN of floating-ip-pool as colon delimited string.
Return FQN of floating-ip-pool’s parent in list form.
Return FQN of floating-ip-pool’s parent as colon delimted string.
Return list of all projects using this floating-ip-pool
Return tag list for floating-ip-pool.
| Returns: | list of <Tag> |
|---|
Return object type (floating-ip-pool).
Get id-perms for floating-ip-pool.
| Returns: | IdPermsType object |
|---|
Get perms2 for floating-ip-pool.
| Returns: | PermType2 object |
|---|
Set tag for floating-ip-pool.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for floating-ip-pool.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Appformix flows node is object representing a logical node in system which serves xflow collectors.
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.
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.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
In-Band interface name used for this flow node.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to flow-node.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-network to flow-node.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Get annotations for flow-node.
| Returns: | KeyValuePairs object |
|---|
Get display-name for flow-node.
| Returns: | xsd:string object |
|---|
Display flow-node object in compact form.
Get flow-node-inband-interface for flow-node.
| Returns: | xsd:string object |
|---|
Get flow-node-ip-address for flow-node.
| Returns: | IpAddressType object |
|---|
Get flow-node-load-balancer-ip for flow-node.
| Returns: | IpAddressType object |
|---|
Return FQN of flow-node in list form.
Return FQN of flow-node as colon delimited string.
Return list of all instance-ips using this flow-node
Return FQN of flow-node’s parent in list form.
Return FQN of flow-node’s parent as colon delimted string.
Return tag list for flow-node.
| Returns: | list of <Tag> |
|---|
Return object type (flow-node).
Return virtual-network list for flow-node.
| Returns: | list of <VirtualNetwork> |
|---|
Get id-perms for flow-node.
| Returns: | IdPermsType object |
|---|
Get perms2 for flow-node.
| Returns: | PermType2 object |
|---|
Set tag for flow-node.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for flow-node.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-network for flow-node.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Set virtual-network list for flow-node.
| Parameters: | ref_obj_list – list of VirtualNetwork object |
|---|
Bases: future.types.newobject.newobject
Link to global-qos config.
Type: int, within [0, 255]
Created By: User (required)
Operations Allowed: CRUD
Description:
Unique ID for this forwarding class.
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.
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.
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.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Referred by:
Add qos-queue to forwarding-class.
| Parameters: | ref_obj – QosQueue object |
|---|
Add tag to forwarding-class.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for forwarding-class.
| Returns: | KeyValuePairs object |
|---|
Get display-name for forwarding-class.
| Returns: | xsd:string object |
|---|
Display forwarding-class object in compact form.
Get forwarding-class-dscp for forwarding-class.
| Returns: | DscpValueType object |
|---|
Get forwarding-class-id for forwarding-class.
| Returns: | ForwardingClassId object |
|---|
Get forwarding-class-mpls-exp for forwarding-class.
| Returns: | MplsExpType object |
|---|
Get forwarding-class-vlan-priority for forwarding-class.
| Returns: | VlanPriorityType object |
|---|
Return FQN of forwarding-class in list form.
Return FQN of forwarding-class as colon delimited string.
Return FQN of forwarding-class’s parent in list form.
Return FQN of forwarding-class’s parent as colon delimted string.
Return qos-queue list for forwarding-class.
| Returns: | list of <QosQueue> |
|---|
Return tag list for forwarding-class.
| Returns: | list of <Tag> |
|---|
Return object type (forwarding-class).
Get id-perms for forwarding-class.
| Returns: | IdPermsType object |
|---|
Get perms2 for forwarding-class.
| Returns: | PermType2 object |
|---|
Set qos-queue for forwarding-class.
| Parameters: | ref_obj – QosQueue object |
|---|
Set qos-queue list for forwarding-class.
| Parameters: | ref_obj_list – list of QosQueue object |
|---|
Set tag for forwarding-class.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for forwarding-class.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
global analytics config related data
- Created By:
- User
- Child of:
- GlobalSystemConfig object
- Properties:
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
- Children:
- list of StructuredSyslogConfig objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of structured-syslog-config that are applicable to objects anchored under global-
analytics-config.
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to global-analytics-config.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for global-analytics-config.
| Returns: | KeyValuePairs object |
|---|
Get display-name for global-analytics-config.
| Returns: | xsd:string object |
|---|
Display global-analytics-config object in compact form.
Return FQN of global-analytics-config in list form.
Return FQN of global-analytics-config as colon delimited string.
Return FQN of global-analytics-config’s parent in list form.
Return FQN of global-analytics-config’s parent as colon delimted string.
Return tag list for global-analytics-config.
| Returns: | list of <Tag> |
|---|
Return object type (global-analytics-config).
Get id-perms for global-analytics-config.
| Returns: | IdPermsType object |
|---|
Get perms2 for global-analytics-config.
| Returns: | PermType2 object |
|---|
Set tag for global-analytics-config.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for global-analytics-config.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Global QoS system config is object where all global system QoS configuration is present.
Type: ControlTrafficDscpType
Created By: User (required)
Operations Allowed: CRUD
Description:
DSCP value of IP header for control traffic
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Global system QoS config for vhost and fabric traffic .
Created By: User (optional)
Operations Allowed: CRUD
Description:
Link to global-qos config.
Created By: User (optional)
Operations Allowed: CRUD
Description:
QOS queue config object in this project.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to global-qos-config.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for global-qos-config.
| Returns: | KeyValuePairs object |
|---|
Get control-traffic-dscp for global-qos-config.
| Returns: | ControlTrafficDscpType object |
|---|
Get display-name for global-qos-config.
| Returns: | xsd:string object |
|---|
Display global-qos-config object in compact form.
Return FQN of global-qos-config in list form.
Return FQN of global-qos-config as colon delimited string.
Return FQN of global-qos-config’s parent in list form.
Return FQN of global-qos-config’s parent as colon delimted string.
Return tag list for global-qos-config.
| Returns: | list of <Tag> |
|---|
Return object type (global-qos-config).
Get id-perms for global-qos-config.
| Returns: | IdPermsType object |
|---|
Get perms2 for global-qos-config.
| Returns: | PermType2 object |
|---|
Set tag for global-qos-config.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for global-qos-config.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Global system config is object where all global system configuration is present.
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.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Knob to enable 4 byte Autonomous System number support.
Type: str
Created By: System
Operations Allowed: R
Description:
Version of OpenContrail software that generated this config.
Type: GracefulRestartParametersType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Graceful Restart parameters
Type: FastConvergenceParametersType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Fast Convergence parameters.
Type: PluginProperties
Created By: User (optional)
Operations Allowed: CRUD
Description:
Various Orchestration system plugin(interface) parameters, like Openstack Neutron plugin.
Type: SubnetListType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Used for assigning loopback addresses on interconnect physical devices.
Type: AsnRangeType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Used for assigning asn values on interconnect physical devices.
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.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Always compare MED even if paths are received from different ASes.
Type: int, within [1, 65535]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Used to create collision-free route distinguishers.
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.
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.
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.
Type: BGPaaServiceParametersType
Created By: User (optional)
Operations Allowed: CRUD
Description:
BGP As A Service Parameters configuration
Type: MACLimitControlType
Created By: User (optional)
Operations Allowed: CRUD
Description:
MAC limit control on the network
Type: MACMoveLimitControlType
Created By: User (optional)
Operations Allowed: CRUD
Description:
MAC move control on the network
Type: int, within [0, 86400]
Created By: User (optional)
Operations Allowed: CRUD
Description:
MAC aging time on the network
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
IGMP mode at Global level.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Flag to enable/disable alarms configured under global-system-config. True, if not set.
Type: UserDefinedLogStatList
Created By: User (optional)
Operations Allowed: CRUD
Description:
stats name and patterns
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
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.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
configurable list of features allowed in this system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of references to all control-node-zones in systems.
Created By: User (required)
Operations Allowed: R
Description:
Global vrouter config is object where all global vrouter config is present.
Created By: User (required)
Operations Allowed: R
Description:
Global QoS system config is object where all global system QoS configuration is present.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Virtual router is packet forwarding system on devices such as compute nodes(servers), TOR(s),
routers.
Created By: User (admin-only)
Operations Allowed: CRUD
Description:
Config node is object representing a logical node in system which serves config API.
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.
Created By: User (admin-only)
Operations Allowed: CRUD
Description:
Appformix flows node is object representing a logical node in system which serves xflow collectors.
Created By: User (admin-only)
Operations Allowed: CRUD
Description:
devicemgr node is object representing a logical node in system for configuring physical devices.
Created By: User (required)
Operations Allowed: CRUD
Description:
Database node is object representing a logical node in system which host Cassandra DB and Zookeeper.
Created By: User (required)
Operations Allowed: CRUD
Description:
WebUI node is object representing a logical node in system which hosts the Contrail UI.
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.
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.
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.
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.
Created By: User (required)
Operations Allowed: CRUD
Description:
Global API access list applicable to all domain and projects
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of alarms that are applicable to objects anchored under global-system-config.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of config properties.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of job templates supported by the system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of DCI Objects in the system. Each DCI represents an interconnect of Multiple Fabrics or
interconnect of LRs in same fabric.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of intent-maps in the system.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of node profiles supported by the system.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of device image info for the images that get uploaded to the system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Parent of this node resource.
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of features supported by the system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of physical roles supported by the system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of overlay roles supported by the system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of role definitions supported by the system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of global-analytics-config that are anchored under global-system-config.
Add bgp-router to global-system-config.
| Parameters: | ref_obj – BgpRouter object |
|---|
Add tag to global-system-config.
| Parameters: | ref_obj – Tag object |
|---|
Get alarm-enable for global-system-config.
| Returns: | xsd:boolean object |
|---|
Get annotations for global-system-config.
| Returns: | KeyValuePairs object |
|---|
Get autonomous-system for global-system-config.
| Returns: | AutonomousSystemType object |
|---|
Get bgp-always-compare-med for global-system-config.
| Returns: | xsd:boolean object |
|---|
Get bgpaas-parameters for global-system-config.
| Returns: | BGPaaServiceParametersType object |
|---|
Get config-version for global-system-config.
| Returns: | xsd:string object |
|---|
Get data-center-interconnect-asn-namespace for global-system-config.
| Returns: | AsnRangeType object |
|---|
Get data-center-interconnect-loopback-namespace for global-system-config.
| Returns: | SubnetListType object |
|---|
Get display-name for global-system-config.
| Returns: | xsd:string object |
|---|
Display global-system-config object in compact form.
Get enable-4byte-as for global-system-config.
| Returns: | xsd:boolean object |
|---|
Get enable-security-policy-draft for global-system-config.
| Returns: | xsd:boolean object |
|---|
Get fast-convergence-parameters for global-system-config.
| Returns: | FastConvergenceParametersType object |
|---|
Return bgp-router list for global-system-config.
| Returns: | list of <BgpRouter> |
|---|
Return FQN of global-system-config in list form.
Return FQN of global-system-config as colon delimited string.
Return FQN of global-system-config’s parent in list form.
Return FQN of global-system-config’s parent as colon delimted string.
Return list of all qos-configs using this global-system-config
Return tag list for global-system-config.
| Returns: | list of <Tag> |
|---|
Return object type (global-system-config).
Get graceful-restart-parameters for global-system-config.
| Returns: | GracefulRestartParametersType object |
|---|
Get ibgp-auto-mesh for global-system-config.
| Returns: | xsd:boolean object |
|---|
Get id-perms for global-system-config.
| Returns: | IdPermsType object |
|---|
Get igmp-enable for global-system-config.
| Returns: | xsd:boolean object |
|---|
Get ip-fabric-subnets for global-system-config.
| Returns: | SubnetListType object |
|---|
Get mac-aging-time for global-system-config.
| Returns: | MACAgingTime object |
|---|
Get mac-limit-control for global-system-config.
| Returns: | MACLimitControlType object |
|---|
Get mac-move-control for global-system-config.
| Returns: | MACMoveLimitControlType object |
|---|
Get perms2 for global-system-config.
| Returns: | PermType2 object |
|---|
Get plugin-tuning for global-system-config.
| Returns: | PluginProperties object |
|---|
Get rd-cluster-seed for global-system-config.
| Returns: | RdClusterSeedType object |
|---|
Set bgp-router for global-system-config.
| Parameters: | ref_obj – BgpRouter object |
|---|
Set bgp-router list for global-system-config.
| Parameters: | ref_obj_list – list of BgpRouter object |
|---|
Set tag for global-system-config.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for global-system-config.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get supported-device-families for global-system-config.
| Returns: | DeviceFamilyListType object |
|---|
Get supported-fabric-annotations for global-system-config.
| Returns: | KeyValuePairs object |
|---|
Get supported-vendor-hardwares for global-system-config.
| Returns: | VendorHardwaresType object |
|---|
Get user-defined-log-statistics for global-system-config.
| Returns: | UserDefinedLogStatList object |
|---|
Bases: future.types.newobject.newobject
Global vrouter config is object where all global vrouter config is present.
Type: EcmpHashingIncludeFields
Created By: User (optional)
Operations Allowed: CRUD
Description:
ECMP hashing config at global level.
Type: LinklocalServicesTypes
Created By: User (optional)
Operations Allowed: CRUD
Description:
Global services provided on link local subnet to the virtual machines.
Type: EncapsulationPrioritiesType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Ordered list of encapsulations that vrouter will use in priority order.
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.
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
Type: FlowAgingTimeoutList
Created By: User (optional)
Operations Allowed: CRUD
Description:
Flow aging timeout per application (protocol, port) list.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Enable or disable security-logging in the system
Type: str, one-of [u’none’, u’all’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Enable encryption mode
Type: EncryptionTunnelEndpointList
Created By: User (optional)
Operations Allowed: CRUD
Description:
Encryption tunnel endpoints list
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.
Type: PortTranslationPools
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of Ports to be reserved for providing underlay connectivity via Port translation.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to security logging object for global-vrouter-config.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to global-vrouter-config.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for global-vrouter-config.
| Returns: | KeyValuePairs object |
|---|
Get display-name for global-vrouter-config.
| Returns: | xsd:string object |
|---|
Display global-vrouter-config object in compact form.
Get ecmp-hashing-include-fields for global-vrouter-config.
| Returns: | EcmpHashingIncludeFields object |
|---|
Get enable-security-logging for global-vrouter-config.
| Returns: | xsd:boolean object |
|---|
Get encapsulation-priorities for global-vrouter-config.
| Returns: | EncapsulationPrioritiesType object |
|---|
Get encryption-mode for global-vrouter-config.
| Returns: | EncryptionMode object |
|---|
Get encryption-tunnel-endpoints for global-vrouter-config.
| Returns: | EncryptionTunnelEndpointList object |
|---|
Get flow-aging-timeout-list for global-vrouter-config.
| Returns: | FlowAgingTimeoutList object |
|---|
Get flow-export-rate for global-vrouter-config.
| Returns: | xsd:integer object |
|---|
Get forwarding-mode for global-vrouter-config.
| Returns: | ForwardingModeType object |
|---|
Return list of all application-policy-sets using this global-vrouter-config
Return FQN of global-vrouter-config in list form.
Return FQN of global-vrouter-config as colon delimited string.
Return FQN of global-vrouter-config’s parent in list form.
Return FQN of global-vrouter-config’s parent as colon delimted string.
Return tag list for global-vrouter-config.
| Returns: | list of <Tag> |
|---|
Return object type (global-vrouter-config).
Get id-perms for global-vrouter-config.
| Returns: | IdPermsType object |
|---|
Get linklocal-services for global-vrouter-config.
| Returns: | LinklocalServicesTypes object |
|---|
Get perms2 for global-vrouter-config.
| Returns: | PermType2 object |
|---|
Get port-translation-pools for global-vrouter-config.
| Returns: | PortTranslationPools object |
|---|
Set tag for global-vrouter-config.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for global-vrouter-config.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get vxlan-network-identifier-mode for global-vrouter-config.
| Returns: | VxlanNetworkIdentifierModeType object |
|---|
Bases: future.types.newobject.newobject
This resource contains information specific to grpc parameters
- Created By:
- User
- Child of:
- Project object
- Properties:
- grpc_profile_is_default
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
This attribute indicates whether it is a default grpc profile or not. Default profiles are non-
editable.
- grpc_parameters
Type: GrpcParameters
Created By: User (optional)
Operations Allowed: CRUD
Description:
Parameters for each grpc profile, such as allow client, top level sensor options etc.
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
- Referred by:
- list of TelemetryProfile objects
Add tag to grpc-profile.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for grpc-profile.
| Returns: | KeyValuePairs object |
|---|
Get display-name for grpc-profile.
| Returns: | xsd:string object |
|---|
Display grpc-profile object in compact form.
Return FQN of grpc-profile in list form.
Return FQN of grpc-profile as colon delimited string.
Return FQN of grpc-profile’s parent in list form.
Return FQN of grpc-profile’s parent as colon delimted string.
Return tag list for grpc-profile.
| Returns: | list of <Tag> |
|---|
Return list of all telemetry-profiles using this grpc-profile
Return object type (grpc-profile).
Get grpc-parameters for grpc-profile.
| Returns: | GrpcParameters object |
|---|
Get grpc-profile-is-default for grpc-profile.
| Returns: | xsd:boolean object |
|---|
Get id-perms for grpc-profile.
| Returns: | IdPermsType object |
|---|
Get perms2 for grpc-profile.
| Returns: | PermType2 object |
|---|
Set tag for grpc-profile.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for grpc-profile.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
This resource contains the information about the device hardware info. This resource name must follow the convention: ‘[vendor name]-[hardware platform name]’, for example, ‘juniper-mx80’.
Created By:
- Properties:
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- Referred by:
- list of NodeProfile objects
- list of DeviceImage objects
Add card to hardware.
| Parameters: | ref_obj – Card object |
|---|
Add tag to hardware.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for hardware.
| Returns: | KeyValuePairs object |
|---|
Get display-name for hardware.
| Returns: | xsd:string object |
|---|
Display hardware object in compact form.
Return card list for hardware.
| Returns: | list of <Card> |
|---|
Return list of all device-images using this hardware
Return FQN of hardware in list form.
Return FQN of hardware as colon delimited string.
Return list of all node-profiles using this hardware
Return tag list for hardware.
| Returns: | list of <Tag> |
|---|
Return object type (hardware).
Get id-perms for hardware.
| Returns: | IdPermsType object |
|---|
Get perms2 for hardware.
| Returns: | PermType2 object |
|---|
Set card for hardware.
| Parameters: | ref_obj – Card object |
|---|
Set card list for hardware.
| Parameters: | ref_obj_list – list of Card object |
|---|
Set tag for hardware.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for hardware.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Hardware Inventory on a physical router.
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
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to hardware-inventory.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for hardware-inventory.
| Returns: | KeyValuePairs object |
|---|
Get display-name for hardware-inventory.
| Returns: | xsd:string object |
|---|
Display hardware-inventory object in compact form.
Return FQN of hardware-inventory in list form.
Return FQN of hardware-inventory as colon delimited string.
Return FQN of hardware-inventory’s parent in list form.
Return FQN of hardware-inventory’s parent as colon delimted string.
Return tag list for hardware-inventory.
| Returns: | list of <Tag> |
|---|
Return object type (hardware-inventory).
Get hardware-inventory-inventory-info for hardware-inventory.
| Returns: | xsd:string object |
|---|
Get id-perms for hardware-inventory.
| Returns: | IdPermsType object |
|---|
Get perms2 for hardware-inventory.
| Returns: | PermType2 object |
|---|
Set tag for hardware-inventory.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for hardware-inventory.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Project level host based service.
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.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to host-based-service.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-network to host-based-service.
| Parameters: |
|
|---|
Get annotations for host-based-service.
| Returns: | KeyValuePairs object |
|---|
Get display-name for host-based-service.
| Returns: | xsd:string object |
|---|
Display host-based-service object in compact form.
Return FQN of host-based-service in list form.
Return FQN of host-based-service as colon delimited string.
Return FQN of host-based-service’s parent in list form.
Return FQN of host-based-service’s parent as colon delimted string.
Return tag list for host-based-service.
| Returns: | list of <Tag> |
|---|
Return object type (host-based-service).
Return virtual-network list for host-based-service.
| Returns: | list of tuple <VirtualNetwork, ServiceVirtualNetworkType> |
|---|
Get host-based-service-type for host-based-service.
| Returns: | HostBasedServiceType object |
|---|
Get id-perms for host-based-service.
| Returns: | IdPermsType object |
|---|
Get perms2 for host-based-service.
| Returns: | PermType2 object |
|---|
Set tag for host-based-service.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for host-based-service.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-network for host-based-service.
| Parameters: |
|
|---|
Set virtual-network list for host-based-service.
| Parameters: |
|
|---|
Bases: future.types.newobject.newobject
Created By:
Type: str, one-of xsd:string
Created By: User (required)
Operations Allowed: CR
Description:
Ip address value for instance ip.
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).
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.
Type: SubnetType
Created By: User (optional)
Operations Allowed: CRUD
Description:
When this instance ip is secondary ip, it can track activeness of another ip.
Type: str
Created By: User (optional)
Operations Allowed: CR
Description:
This instance ip was allocated from this Subnet(UUID).
Type: str
Created By: User (optional)
Operations Allowed: CR
Description:
This instance ip belongs to one of the subscribers in the subscriber-tag.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
This instance ip is secondary ip of the interface.
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.
Type: bool
Created By: System
Operations Allowed: CRUD
Description:
This instance ip is used as service chain next hop
Type: bool
Created By: System
Operations Allowed: CRUD
Description:
This instance ip is used as service health check source ip
Type: SubnetType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Ip prefix/length of the subnet where instance-ip belongs.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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.
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.
Created By: User (required)
Operations Allowed: CRUD
Description:
Reference to virtual network of this instance ip.
Created By: User (required)
Operations Allowed: CRUD
Description:
Reference to network ipam of this instance ip.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to virtual machine interface to which this instance ip is attached.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to virtual router of this instance ip.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to the logical interface that this instance ip is assigned to.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to the flow node that this instance ip is assigned to.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add flow-node to instance-ip.
| Parameters: | ref_obj – FlowNode object |
|---|
Add logical-interface to instance-ip.
| Parameters: | ref_obj – LogicalInterface object |
|---|
Add network-ipam to instance-ip.
| Parameters: | ref_obj – NetworkIpam object |
|---|
Add physical-router to instance-ip.
| Parameters: | ref_obj – PhysicalRouter object |
|---|
Add tag to instance-ip.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-machine-interface to instance-ip.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Add virtual-network to instance-ip.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Add virtual-router to instance-ip.
| Parameters: | ref_obj – VirtualRouter object |
|---|
Get annotations for instance-ip.
| Returns: | KeyValuePairs object |
|---|
Get display-name for instance-ip.
| Returns: | xsd:string object |
|---|
Display instance-ip object in compact form.
Return flow-node list for instance-ip.
| Returns: | list of <FlowNode> |
|---|
Return FQN of instance-ip in list form.
Return FQN of instance-ip as colon delimited string.
Return logical-interface list for instance-ip.
| Returns: | list of <LogicalInterface> |
|---|
Return network-ipam list for instance-ip.
| Returns: | list of <NetworkIpam> |
|---|
Return physical-router list for instance-ip.
| Returns: | list of <PhysicalRouter> |
|---|
Return list of all service-instances using this instance-ip
Return tag list for instance-ip.
| Returns: | list of <Tag> |
|---|
Return object type (instance-ip).
Return virtual-machine-interface list for instance-ip.
| Returns: | list of <VirtualMachineInterface> |
|---|
Return virtual-network list for instance-ip.
| Returns: | list of <VirtualNetwork> |
|---|
Return virtual-router list for instance-ip.
| Returns: | list of <VirtualRouter> |
|---|
Get id-perms for instance-ip.
| Returns: | IdPermsType object |
|---|
Get instance-ip-address for instance-ip.
| Returns: | IpAddressType object |
|---|
Get instance-ip-family for instance-ip.
| Returns: | IpAddressFamilyType object |
|---|
Get instance-ip-local-ip for instance-ip.
| Returns: | xsd:boolean object |
|---|
Get instance-ip-mode for instance-ip.
| Returns: | AddressMode object |
|---|
Get instance-ip-secondary for instance-ip.
| Returns: | xsd:boolean object |
|---|
Get instance-ip-subnet for instance-ip.
| Returns: | SubnetType object |
|---|
Get instance-ip-subscriber-tag for instance-ip.
| Returns: | xsd:string object |
|---|
Get perms2 for instance-ip.
| Returns: | PermType2 object |
|---|
Get secondary-ip-tracking-ip for instance-ip.
| Returns: | SubnetType object |
|---|
Get service-health-check-ip for instance-ip.
| Returns: | xsd:boolean object |
|---|
Get service-instance-ip for instance-ip.
| Returns: | xsd:boolean object |
|---|
Set flow-node for instance-ip.
| Parameters: | ref_obj – FlowNode object |
|---|
Set flow-node list for instance-ip.
| Parameters: | ref_obj_list – list of FlowNode object |
|---|
Set logical-interface for instance-ip.
| Parameters: | ref_obj – LogicalInterface object |
|---|
Set logical-interface list for instance-ip.
| Parameters: | ref_obj_list – list of LogicalInterface object |
|---|
Set network-ipam for instance-ip.
| Parameters: | ref_obj – NetworkIpam object |
|---|
Set network-ipam list for instance-ip.
| Parameters: | ref_obj_list – list of NetworkIpam object |
|---|
Set physical-router for instance-ip.
| Parameters: | ref_obj – PhysicalRouter object |
|---|
Set physical-router list for instance-ip.
| Parameters: | ref_obj_list – list of PhysicalRouter object |
|---|
Set tag for instance-ip.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for instance-ip.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-machine-interface for instance-ip.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Set virtual-machine-interface list for instance-ip.
| Parameters: | ref_obj_list – list of VirtualMachineInterface object |
|---|
Set virtual-network for instance-ip.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Set virtual-network list for instance-ip.
| Parameters: | ref_obj_list – list of VirtualNetwork object |
|---|
Set virtual-router for instance-ip.
| Parameters: | ref_obj – VirtualRouter object |
|---|
Set virtual-router list for instance-ip.
| Parameters: | ref_obj_list – list of VirtualRouter object |
|---|
Get subnet-uuid for instance-ip.
| Returns: | xsd:string object |
|---|
Bases: future.types.newobject.newobject
List of intent-maps in the system.
Type: str, one-of [u’assisted-replicator’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Based on this value we determine what intent model we are serving
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to intent-map.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for intent-map.
| Returns: | KeyValuePairs object |
|---|
Get display-name for intent-map.
| Returns: | xsd:string object |
|---|
Display intent-map object in compact form.
Return list of all fabrics using this intent-map
Return FQN of intent-map in list form.
Return FQN of intent-map as colon delimited string.
Return FQN of intent-map’s parent in list form.
Return FQN of intent-map’s parent as colon delimted string.
Return list of all physical-routers using this intent-map
Return tag list for intent-map.
| Returns: | list of <Tag> |
|---|
Return object type (intent-map).
Return list of all virtual-networks using this intent-map
Get id-perms for intent-map.
| Returns: | IdPermsType object |
|---|
Get intent-map-intent-type for intent-map.
| Returns: | IntentType object |
|---|
Get perms2 for intent-map.
| Returns: | PermType2 object |
|---|
Set tag for intent-map.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for intent-map.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Interface route table is mechanism to add static routes pointing to this interface.
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.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add service-instance to interface-route-table.
| Parameters: |
|
|---|
Add tag to interface-route-table.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for interface-route-table.
| Returns: | KeyValuePairs object |
|---|
Get display-name for interface-route-table.
| Returns: | xsd:string object |
|---|
Display interface-route-table object in compact form.
Return FQN of interface-route-table in list form.
Return FQN of interface-route-table as colon delimited string.
Return FQN of interface-route-table’s parent in list form.
Return FQN of interface-route-table’s parent as colon delimted string.
Return list of all routing-policys using this interface-route-table
Return service-instance list for interface-route-table.
| Returns: | list of tuple <ServiceInstance, ServiceInterfaceTag> |
|---|
Return tag list for interface-route-table.
| Returns: | list of <Tag> |
|---|
Return object type (interface-route-table).
Return list of all virtual-machine-interfaces using this interface-route-table
Get id-perms for interface-route-table.
| Returns: | IdPermsType object |
|---|
Get interface-route-table-routes for interface-route-table.
| Returns: | RouteTableType object |
|---|
Get perms2 for interface-route-table.
| Returns: | PermType2 object |
|---|
Set service-instance for interface-route-table.
| Parameters: |
|
|---|
Set service-instance list for interface-route-table.
| Parameters: |
|
|---|
Set tag for interface-route-table.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for interface-route-table.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
List of job templates supported by the system.
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”.
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)
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.
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
Type: PlaybookInfoListType
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of vendor specific playbooks that can be used to recover from an error in the workflow. All the
vendor specific playbooks listed here share the same input/output schema defined in the job template
Type: ExecutableInfoListType
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of Executables that needs to be Executed
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”]}
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.
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.
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.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
A detailed description of what the job template functionality is
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to job-template.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for job-template.
| Returns: | KeyValuePairs object |
|---|
Get display-name for job-template.
| Returns: | xsd:string object |
|---|
Display job-template object in compact form.
Return FQN of job-template in list form.
Return FQN of job-template as colon delimited string.
Return list of all node-profiles using this job-template
Return FQN of job-template’s parent in list form.
Return FQN of job-template’s parent as colon delimted string.
Return tag list for job-template.
| Returns: | list of <Tag> |
|---|
Return object type (job-template).
Get id-perms for job-template.
| Returns: | IdPermsType object |
|---|
Get job-template-concurrency-level for job-template.
| Returns: | JobConcurrencyLevelType object |
|---|
Get job-template-description for job-template.
| Returns: | xsd:string object |
|---|
Get job-template-executables for job-template.
| Returns: | ExecutableInfoListType object |
|---|
Get job-template-input-schema for job-template.
| Returns: | xsd:string object |
|---|
Get job-template-input-ui-schema for job-template.
| Returns: | xsd:string object |
|---|
Get job-template-output-schema for job-template.
| Returns: | xsd:string object |
|---|
Get job-template-output-ui-schema for job-template.
| Returns: | xsd:string object |
|---|
Get job-template-playbooks for job-template.
| Returns: | PlaybookInfoListType object |
|---|
Get job-template-recovery-playbooks for job-template.
| Returns: | PlaybookInfoListType object |
|---|
Get job-template-synchronous-job for job-template.
| Returns: | xsd:boolean object |
|---|
Get job-template-type for job-template.
| Returns: | JobTemplateType object |
|---|
Get perms2 for job-template.
| Returns: | PermType2 object |
|---|
Set tag for job-template.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for job-template.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
List of link aggregation groups on this PRouter.
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.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of virtual machine interfaces connected to this link aggregation group
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add physical-interface to link-aggregation-group.
| Parameters: | ref_obj – PhysicalInterface object |
|---|
Add tag to link-aggregation-group.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-machine-interface to link-aggregation-group.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Get annotations for link-aggregation-group.
| Returns: | KeyValuePairs object |
|---|
Get display-name for link-aggregation-group.
| Returns: | xsd:string object |
|---|
Display link-aggregation-group object in compact form.
Return FQN of link-aggregation-group in list form.
Return FQN of link-aggregation-group as colon delimited string.
Return FQN of link-aggregation-group’s parent in list form.
Return FQN of link-aggregation-group’s parent as colon delimted string.
Return physical-interface list for link-aggregation-group.
| Returns: | list of <PhysicalInterface> |
|---|
Return tag list for link-aggregation-group.
| Returns: | list of <Tag> |
|---|
Return object type (link-aggregation-group).
Return virtual-machine-interface list for link-aggregation-group.
| Returns: | list of <VirtualMachineInterface> |
|---|
Get id-perms for link-aggregation-group.
| Returns: | IdPermsType object |
|---|
Get link-aggregation-group-lacp-enabled for link-aggregation-group.
| Returns: | xsd:boolean object |
|---|
Get perms2 for link-aggregation-group.
| Returns: | PermType2 object |
|---|
Set physical-interface for link-aggregation-group.
| Parameters: | ref_obj – PhysicalInterface object |
|---|
Set physical-interface list for link-aggregation-group.
| Parameters: | ref_obj_list – list of PhysicalInterface object |
|---|
Set tag for link-aggregation-group.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for link-aggregation-group.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-machine-interface for link-aggregation-group.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Set virtual-machine-interface list for link-aggregation-group.
| Parameters: | ref_obj_list – list of VirtualMachineInterface object |
|---|
Bases: future.types.newobject.newobject
Loadbalancer object represents a LBaaS instance. One single Virtual IP and multiple (listeners, pools). Applicable to LBaaS V2.
Type: LoadbalancerType
Created By: User (required)
Operations Allowed: CRUD
Description:
Loadbalancer configuration like admin state, VIP, VIP subnet etc.
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.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: System
Operations Allowed: CRUD
Description:
Reference to the service instance, created automatically by the system.
Created By: System
Operations Allowed: CRUD
Description:
Reference to the virtual machine interface for VIP, created automatically by the system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add service-appliance-set to loadbalancer.
| Parameters: | ref_obj – ServiceApplianceSet object |
|---|
Add service-instance to loadbalancer.
| Parameters: | ref_obj – ServiceInstance object |
|---|
Add tag to loadbalancer.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-machine-interface to loadbalancer.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Get annotations for loadbalancer.
| Returns: | KeyValuePairs object |
|---|
Get display-name for loadbalancer.
| Returns: | xsd:string object |
|---|
Display loadbalancer object in compact form.
Return FQN of loadbalancer in list form.
Return FQN of loadbalancer as colon delimited string.
Return list of all loadbalancer-listeners using this loadbalancer
Return FQN of loadbalancer’s parent in list form.
Return FQN of loadbalancer’s parent as colon delimted string.
Return service-appliance-set list for loadbalancer.
| Returns: | list of <ServiceApplianceSet> |
|---|
Return service-instance list for loadbalancer.
| Returns: | list of <ServiceInstance> |
|---|
Return tag list for loadbalancer.
| Returns: | list of <Tag> |
|---|
Return object type (loadbalancer).
Return virtual-machine-interface list for loadbalancer.
| Returns: | list of <VirtualMachineInterface> |
|---|
Get id-perms for loadbalancer.
| Returns: | IdPermsType object |
|---|
Get loadbalancer-properties for loadbalancer.
| Returns: | LoadbalancerType object |
|---|
Get loadbalancer-provider for loadbalancer.
| Returns: | xsd:string object |
|---|
Get perms2 for loadbalancer.
| Returns: | PermType2 object |
|---|
Set service-appliance-set for loadbalancer.
| Parameters: | ref_obj – ServiceApplianceSet object |
|---|
Set service-appliance-set list for loadbalancer.
| Parameters: | ref_obj_list – list of ServiceApplianceSet object |
|---|
Set service-instance for loadbalancer.
| Parameters: | ref_obj – ServiceInstance object |
|---|
Set service-instance list for loadbalancer.
| Parameters: | ref_obj_list – list of ServiceInstance object |
|---|
Set tag for loadbalancer.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for loadbalancer.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-machine-interface for loadbalancer.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Set virtual-machine-interface list for loadbalancer.
| Parameters: | ref_obj_list – list of VirtualMachineInterface object |
|---|
Bases: future.types.newobject.newobject
Health monitor objects is configuration to monitor health of individual pool members.
Type: LoadbalancerHealthmonitorType
Created By: User (required)
Operations Allowed: CRUD
Description:
Configuration parameters for health monitor like type, method, retries etc.
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to loadbalancer-healthmonitor.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for loadbalancer-healthmonitor.
| Returns: | KeyValuePairs object |
|---|
Get display-name for loadbalancer-healthmonitor.
| Returns: | xsd:string object |
|---|
Display loadbalancer-healthmonitor object in compact form.
Return FQN of loadbalancer-healthmonitor in list form.
Return FQN of loadbalancer-healthmonitor as colon delimited string.
Return list of all loadbalancer-pools using this loadbalancer-healthmonitor
Return FQN of loadbalancer-healthmonitor’s parent in list form.
Return FQN of loadbalancer-healthmonitor’s parent as colon delimted string.
Return tag list for loadbalancer-healthmonitor.
| Returns: | list of <Tag> |
|---|
Return object type (loadbalancer-healthmonitor).
Get id-perms for loadbalancer-healthmonitor.
| Returns: | IdPermsType object |
|---|
Get loadbalancer-healthmonitor-properties for loadbalancer-healthmonitor.
| Returns: | LoadbalancerHealthmonitorType object |
|---|
Get perms2 for loadbalancer-healthmonitor.
| Returns: | PermType2 object |
|---|
Set tag for loadbalancer-healthmonitor.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for loadbalancer-healthmonitor.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Listener represents the application(protocol, port) to be load balanced.
Type: LoadbalancerListenerType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add loadbalancer to loadbalancer-listener.
| Parameters: | ref_obj – Loadbalancer object |
|---|
Add tag to loadbalancer-listener.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for loadbalancer-listener.
| Returns: | KeyValuePairs object |
|---|
Get display-name for loadbalancer-listener.
| Returns: | xsd:string object |
|---|
Display loadbalancer-listener object in compact form.
Return FQN of loadbalancer-listener in list form.
Return FQN of loadbalancer-listener as colon delimited string.
Return list of all loadbalancer-pools using this loadbalancer-listener
Return loadbalancer list for loadbalancer-listener.
| Returns: | list of <Loadbalancer> |
|---|
Return FQN of loadbalancer-listener’s parent in list form.
Return FQN of loadbalancer-listener’s parent as colon delimted string.