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.
Return tag list for loadbalancer-listener.
| Returns: | list of <Tag> |
|---|
Return object type (loadbalancer-listener).
Get id-perms for loadbalancer-listener.
| Returns: | IdPermsType object |
|---|
Get loadbalancer-listener-properties for loadbalancer-listener.
| Returns: | LoadbalancerListenerType object |
|---|
Get perms2 for loadbalancer-listener.
| Returns: | PermType2 object |
|---|
Set loadbalancer for loadbalancer-listener.
| Parameters: | ref_obj – Loadbalancer object |
|---|
Set loadbalancer list for loadbalancer-listener.
| Parameters: | ref_obj_list – list of Loadbalancer object |
|---|
Set tag for loadbalancer-listener.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for loadbalancer-listener.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Configuration object representing each member of load balancer pool.
Type: LoadbalancerMemberType
Created By: User (required)
Operations Allowed: CRUD
Description:
Member configuration like ip address, destination port, weight 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
Referred by:
Add tag to loadbalancer-member.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for loadbalancer-member.
| Returns: | KeyValuePairs object |
|---|
Get display-name for loadbalancer-member.
| Returns: | xsd:string object |
|---|
Display loadbalancer-member object in compact form.
Return FQN of loadbalancer-member in list form.
Return FQN of loadbalancer-member as colon delimited string.
Return FQN of loadbalancer-member’s parent in list form.
Return FQN of loadbalancer-member’s parent as colon delimted string.
Return tag list for loadbalancer-member.
| Returns: | list of <Tag> |
|---|
Return object type (loadbalancer-member).
Get id-perms for loadbalancer-member.
| Returns: | IdPermsType object |
|---|
Get loadbalancer-member-properties for loadbalancer-member.
| Returns: | LoadbalancerMemberType object |
|---|
Get perms2 for loadbalancer-member.
| Returns: | PermType2 object |
|---|
Set tag for loadbalancer-member.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for loadbalancer-member.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Loadbalancer pool object represent set(pool) member servers which needs load balancing.
Type: LoadbalancerPoolType
Created By: User (required)
Operations Allowed: CRUD
Description:
Configuration for loadbalancer pool like protocol, 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. Applicable to LBaaS V1
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Custom loadbalancer config, opaque to the system. Specified as list of Key:Value pairs. Applicable
to LBaaS V1.
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:
Configuration object representing each member of load balancer pool.
Created By: System
Operations Allowed: CR
Description:
Reference to the service instance serving this pool, applicable to LBaaS V1.
Created By: System
Operations Allowed: CR
Description:
Reference to the virtual machine interface reaching pool subnet, applicable to LBaaS V1.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to loadbalancer listener served by this pool, applicable to LBaaS V2.
Created By: System
Operations Allowed: RReference to service-appliance-set where this loadbalancer-pool is hosted. Applicable to LBaaS V1.
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to loadbalancer healthmonitor that this pool uses.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add loadbalancer-healthmonitor to loadbalancer-pool.
| Parameters: | ref_obj – LoadbalancerHealthmonitor object |
|---|
Add loadbalancer-listener to loadbalancer-pool.
| Parameters: | ref_obj – LoadbalancerListener object |
|---|
Add service-appliance-set to loadbalancer-pool.
| Parameters: | ref_obj – ServiceApplianceSet object |
|---|
Add service-instance to loadbalancer-pool.
| Parameters: | ref_obj – ServiceInstance object |
|---|
Add tag to loadbalancer-pool.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-machine-interface to loadbalancer-pool.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Get annotations for loadbalancer-pool.
| Returns: | KeyValuePairs object |
|---|
Get display-name for loadbalancer-pool.
| Returns: | xsd:string object |
|---|
Display loadbalancer-pool object in compact form.
Return FQN of loadbalancer-pool in list form.
Return FQN of loadbalancer-pool as colon delimited string.
Return loadbalancer-healthmonitor list for loadbalancer-pool.
| Returns: | list of <LoadbalancerHealthmonitor> |
|---|
Return loadbalancer-listener list for loadbalancer-pool.
| Returns: | list of <LoadbalancerListener> |
|---|
Return FQN of loadbalancer-pool’s parent in list form.
Return FQN of loadbalancer-pool’s parent as colon delimted string.
Return service-appliance-set list for loadbalancer-pool.
| Returns: | list of <ServiceApplianceSet> |
|---|
Return service-instance list for loadbalancer-pool.
| Returns: | list of <ServiceInstance> |
|---|
Return tag list for loadbalancer-pool.
| Returns: | list of <Tag> |
|---|
Return object type (loadbalancer-pool).
Return list of all virtual-ips using this loadbalancer-pool
Return virtual-machine-interface list for loadbalancer-pool.
| Returns: | list of <VirtualMachineInterface> |
|---|
Get id-perms for loadbalancer-pool.
| Returns: | IdPermsType object |
|---|
Get loadbalancer-pool-custom-attributes for loadbalancer-pool.
| Returns: | KeyValuePairs object |
|---|
Get loadbalancer-pool-properties for loadbalancer-pool.
| Returns: | LoadbalancerPoolType object |
|---|
Get loadbalancer-pool-provider for loadbalancer-pool.
| Returns: | xsd:string object |
|---|
Get perms2 for loadbalancer-pool.
| Returns: | PermType2 object |
|---|
Set loadbalancer-healthmonitor for loadbalancer-pool.
| Parameters: | ref_obj – LoadbalancerHealthmonitor object |
|---|
Set loadbalancer-healthmonitor list for loadbalancer-pool.
| Parameters: | ref_obj_list – list of LoadbalancerHealthmonitor object |
|---|
Set loadbalancer-listener for loadbalancer-pool.
| Parameters: | ref_obj – LoadbalancerListener object |
|---|
Set loadbalancer-listener list for loadbalancer-pool.
| Parameters: | ref_obj_list – list of LoadbalancerListener object |
|---|
Set service-appliance-set for loadbalancer-pool.
| Parameters: | ref_obj – ServiceApplianceSet object |
|---|
Set service-appliance-set list for loadbalancer-pool.
| Parameters: | ref_obj_list – list of ServiceApplianceSet object |
|---|
Set service-instance for loadbalancer-pool.
| Parameters: | ref_obj – ServiceInstance object |
|---|
Set service-instance list for loadbalancer-pool.
| Parameters: | ref_obj_list – list of ServiceInstance object |
|---|
Set tag for loadbalancer-pool.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for loadbalancer-pool.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-machine-interface for loadbalancer-pool.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Set virtual-machine-interface list for loadbalancer-pool.
| Parameters: | ref_obj_list – list of VirtualMachineInterface object |
|---|
Bases: future.types.newobject.newobject
Type: int
Created By: User (optional)
Operations Allowed: CRUD
Description:
VLAN tag (.1Q) classifier for this logical interface.
Type: PortParameters
Created By: User (optional)
Operations Allowed: CRUD
Description:
User can select this option to configure port parameters such as description, MTU and port enable or
disable.
Type: str, one-of [u’l2’, u’l3’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Logical interface type can be L2 or L3.
L2 - only L2 service is provided, MAC learning is supported.
L3 - only L3 service is supported and MAC learning is not supported.
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:
References to virtual machine interfaces that represent end points that are reachable by this
logical interface.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to logical-interface.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-machine-interface to logical-interface.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Get annotations for logical-interface.
| Returns: | KeyValuePairs object |
|---|
Get display-name for logical-interface.
| Returns: | xsd:string object |
|---|
Display logical-interface object in compact form.
Return FQN of logical-interface in list form.
Return FQN of logical-interface as colon delimited string.
Return list of all instance-ips using this logical-interface
Return FQN of logical-interface’s parent in list form.
Return FQN of logical-interface’s parent as colon delimted string.
Return tag list for logical-interface.
| Returns: | list of <Tag> |
|---|
Return object type (logical-interface).
Return virtual-machine-interface list for logical-interface.
| Returns: | list of <VirtualMachineInterface> |
|---|
Get id-perms for logical-interface.
| Returns: | IdPermsType object |
|---|
Get logical-interface-port-params for logical-interface.
| Returns: | PortParameters object |
|---|
Get logical-interface-type for logical-interface.
| Returns: | LogicalInterfaceType object |
|---|
Get logical-interface-vlan-tag for logical-interface.
| Returns: | xsd:integer object |
|---|
Get perms2 for logical-interface.
| Returns: | PermType2 object |
|---|
Set tag for logical-interface.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for logical-interface.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-machine-interface for logical-interface.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Set virtual-machine-interface list for logical-interface.
| Parameters: | ref_obj_list – list of VirtualMachineInterface object |
|---|
Bases: future.types.newobject.newobject
Logical router is a mechanism to connect multiple virtual network as they have been connected by a 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
logical router will have this as their route target list.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
The VNI that needs to be associated with the internal VN if vxlan_routing mode is enabled.
Type: IpAddressesType
Created By: User (optional)
Operations Allowed: CRUD
Description:
DHCP server IP(s) to serve managed BMS(s).
Type: bool
Created By: User (required)
Operations Allowed: CRUD
Description:
this logical router is used for external connectivity or not.
Type: str, one-of [u’snat-routing’, u’vxlan-routing’]
Created By: User (optional)
Operations Allowed: CRD
Description:
Type of logical-router, used to signify the purpose of the logical-router.
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 the interface attached to this logical router. By attaching a interface to logical
network all subnets in the virtual network of the interface has this router.
Created By: System
Operations Allowed: CRUD
Description:
Route target that represent this logical router.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to the route table attached to this logical router. By attaching route table, system will
create static routes with the route target only of route targets linked to this logical router
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to a virtual network. Please refer to link attribute for additional details
Created By: System
Operations Allowed: CRUD
Description:
Reference to service instance doing SNAT functionality for external gateway.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to physical router, when this link is present device manager configures logical router
associated route targets/interfaces on the Physical Router.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to fabric, this link enables to identify which fabric, the device this LR belongs to is
on.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Back reference to logical router associated to the BGP VPN resource
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add bgpvpn to logical-router.
| Parameters: | ref_obj – Bgpvpn object |
|---|
Add fabric to logical-router.
| Parameters: | ref_obj – Fabric object |
|---|
Add physical-router to logical-router.
| Parameters: | ref_obj – PhysicalRouter object |
|---|
Add route-table to logical-router.
| Parameters: | ref_obj – RouteTable object |
|---|
Add route-target to logical-router.
| Parameters: | ref_obj – RouteTarget object |
|---|
Add service-instance to logical-router.
| Parameters: | ref_obj – ServiceInstance object |
|---|
Add tag to logical-router.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-machine-interface to logical-router.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Add virtual-network to logical-router.
| Parameters: |
|
|---|
Get annotations for logical-router.
| Returns: | KeyValuePairs object |
|---|
Get configured-route-target-list for logical-router.
| Returns: | RouteTargetList object |
|---|
Get display-name for logical-router.
| Returns: | xsd:string object |
|---|
Display logical-router object in compact form.
Return bgpvpn list for logical-router.
| Returns: | list of <Bgpvpn> |
|---|
Return list of all data-center-interconnects using this logical-router
Return fabric list for logical-router.
| Returns: | list of <Fabric> |
|---|
Return FQN of logical-router in list form.
Return FQN of logical-router as colon delimited string.
Return FQN of logical-router’s parent in list form.
Return FQN of logical-router’s parent as colon delimted string.
Return physical-router list for logical-router.
| Returns: | list of <PhysicalRouter> |
|---|
Return list of all port-tuples using this logical-router
Return route-table list for logical-router.
| Returns: | list of <RouteTable> |
|---|
Return route-target list for logical-router.
| Returns: | list of <RouteTarget> |
|---|
Return service-instance list for logical-router.
| Returns: | list of <ServiceInstance> |
|---|
Return tag list for logical-router.
| Returns: | list of <Tag> |
|---|
Return object type (logical-router).
Return virtual-machine-interface list for logical-router.
| Returns: | list of <VirtualMachineInterface> |
|---|
Return virtual-network list for logical-router.
| Returns: | list of tuple <VirtualNetwork, LogicalRouterVirtualNetworkType> |
|---|
Get id-perms for logical-router.
| Returns: | IdPermsType object |
|---|
Get logical-router-dhcp-relay-server for logical-router.
| Returns: | IpAddressesType object |
|---|
Get logical-router-gateway-external for logical-router.
| Returns: | xsd:boolean object |
|---|
Get logical-router-type for logical-router.
| Returns: | LogicalRouterType object |
|---|
Get perms2 for logical-router.
| Returns: | PermType2 object |
|---|
Set bgpvpn for logical-router.
| Parameters: | ref_obj – Bgpvpn object |
|---|
Set bgpvpn list for logical-router.
| Parameters: | ref_obj_list – list of Bgpvpn object |
|---|
Set fabric for logical-router.
| Parameters: | ref_obj – Fabric object |
|---|
Set fabric list for logical-router.
| Parameters: | ref_obj_list – list of Fabric object |
|---|
Set physical-router for logical-router.
| Parameters: | ref_obj – PhysicalRouter object |
|---|
Set physical-router list for logical-router.
| Parameters: | ref_obj_list – list of PhysicalRouter object |
|---|
Set route-table for logical-router.
| Parameters: | ref_obj – RouteTable object |
|---|
Set route-table list for logical-router.
| Parameters: | ref_obj_list – list of RouteTable object |
|---|
Set route-target for logical-router.
| Parameters: | ref_obj – RouteTarget object |
|---|
Set route-target list for logical-router.
| Parameters: | ref_obj_list – list of RouteTarget object |
|---|
Set service-instance for logical-router.
| Parameters: | ref_obj – ServiceInstance object |
|---|
Set service-instance list for logical-router.
| Parameters: | ref_obj_list – list of ServiceInstance object |
|---|
Set tag for logical-router.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for logical-router.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-machine-interface for logical-router.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Set virtual-machine-interface list for logical-router.
| Parameters: | ref_obj_list – list of VirtualMachineInterface object |
|---|
Set virtual-network for logical-router.
| Parameters: |
|
|---|
Set virtual-network list for logical-router.
| Parameters: |
|
|---|
Get vxlan-network-identifier for logical-router.
| Returns: | xsd:string object |
|---|
Bases: future.types.newobject.newobject
List of references of child multicast policy objects. automatically maintained by system.
Type: MulticastSourceGroups
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of Multicast (S,G) Addresses.
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 multicast-policy.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for multicast-policy.
| Returns: | KeyValuePairs object |
|---|
Get display-name for multicast-policy.
| Returns: | xsd:string object |
|---|
Display multicast-policy object in compact form.
Return FQN of multicast-policy in list form.
Return FQN of multicast-policy as colon delimited string.
Return FQN of multicast-policy’s parent in list form.
Return FQN of multicast-policy’s parent as colon delimted string.
Return tag list for multicast-policy.
| Returns: | list of <Tag> |
|---|
Return object type (multicast-policy).
Return list of all virtual-networks using this multicast-policy
Get id-perms for multicast-policy.
| Returns: | IdPermsType object |
|---|
Get multicast-source-groups for multicast-policy.
| Returns: | MulticastSourceGroups object |
|---|
Get perms2 for multicast-policy.
| Returns: | PermType2 object |
|---|
Set tag for multicast-policy.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for multicast-policy.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Namespace is unique networking namespace within this domain. If namespace is not present then default namespace of default project is used.
Type: SubnetType
Created By: User (optional)
Operations Allowed: CRUD
Description:
All networks in this namespace belong to this list of Prefixes. Not 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.
Children:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to namespace.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for namespace.
| Returns: | KeyValuePairs object |
|---|
Get display-name for namespace.
| Returns: | xsd:string object |
|---|
Display namespace object in compact form.
Return FQN of namespace in list form.
Return FQN of namespace as colon delimited string.
Return FQN of namespace’s parent in list form.
Return FQN of namespace’s parent as colon delimted string.
Return list of all projects using this namespace
Return tag list for namespace.
| Returns: | list of <Tag> |
|---|
Return object type (namespace).
Get id-perms for namespace.
| Returns: | IdPermsType object |
|---|
Get namespace-cidr for namespace.
| Returns: | SubnetType object |
|---|
Get perms2 for namespace.
| Returns: | PermType2 object |
|---|
Set tag for namespace.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for namespace.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
This resource contains information specific to netconf parameters
- Created By:
- User
- Child of:
- Project object
- Properties:
- netconf_profile_is_default
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
This attribute indicates whether it is a default netconf profile or not. Default profiles are non-
editable.
- netconf_parameters
Type: NetconfParameters
Created By: User (optional)
Operations Allowed: CRUD
Description:
Parameters for each netconf profile like the top level sensor options etc.
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
- Referred by:
- list of TelemetryProfile objects
Add tag to netconf-profile.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for netconf-profile.
| Returns: | KeyValuePairs object |
|---|
Get display-name for netconf-profile.
| Returns: | xsd:string object |
|---|
Display netconf-profile object in compact form.
Return FQN of netconf-profile in list form.
Return FQN of netconf-profile as colon delimited string.
Return FQN of netconf-profile’s parent in list form.
Return FQN of netconf-profile’s parent as colon delimted string.
Return tag list for netconf-profile.
| Returns: | list of <Tag> |
|---|
Return list of all telemetry-profiles using this netconf-profile
Return object type (netconf-profile).
Get id-perms for netconf-profile.
| Returns: | IdPermsType object |
|---|
Get netconf-parameters for netconf-profile.
| Returns: | NetconfParameters object |
|---|
Get netconf-profile-is-default for netconf-profile.
| Returns: | xsd:boolean object |
|---|
Get perms2 for netconf-profile.
| Returns: | PermType2 object |
|---|
Set tag for netconf-profile.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for netconf-profile.
| 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.
Children:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Network device config of a physical router.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add physical-router to network-device-config.
| Parameters: | ref_obj – PhysicalRouter object |
|---|
Add tag to network-device-config.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for network-device-config.
| Returns: | KeyValuePairs object |
|---|
Get display-name for network-device-config.
| Returns: | xsd:string object |
|---|
Display network-device-config object in compact form.
Return FQN of network-device-config in list form.
Return FQN of network-device-config as colon delimited string.
Return physical-router list for network-device-config.
| Returns: | list of <PhysicalRouter> |
|---|
Return tag list for network-device-config.
| Returns: | list of <Tag> |
|---|
Return object type (network-device-config).
Get id-perms for network-device-config.
| Returns: | IdPermsType object |
|---|
Get perms2 for network-device-config.
| Returns: | PermType2 object |
|---|
Set physical-router for network-device-config.
| Parameters: | ref_obj – PhysicalRouter object |
|---|
Set physical-router list for network-device-config.
| Parameters: | ref_obj_list – list of PhysicalRouter object |
|---|
Set tag for network-device-config.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for network-device-config.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
IP Address Management object that controls, ip allocation, DNS and DHCP
Type: IpamType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Network IP Address Management configuration.
Type: IpamSubnets
Created By: User (optional)
Operations Allowed: CRD
Description:
List of subnets for this ipam.
Type: str, one-of [u’user-defined-subnet’, u’flat-subnet’, u’auto-subnet’]
Created By: User (optional)
Operations Allowed: CRD
Description:
Subnet method configuration for ipam, user can configure user-defined, flat or auto.
Type: bool
Created By: User (optional)
Operations Allowed: CRD
Description:
This flag indicates if ipam subnets are carved out from a big subnet, default behavior is False.
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 virtual DNS used by this IPAM.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to network-ipam.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-DNS to network-ipam.
| Parameters: | ref_obj – VirtualDns object |
|---|
Get annotations for network-ipam.
| Returns: | KeyValuePairs object |
|---|
Get display-name for network-ipam.
| Returns: | xsd:string object |
|---|
Display network-ipam object in compact form.
Return FQN of network-ipam in list form.
Return FQN of network-ipam as colon delimited string.
Return list of all instance-ips using this network-ipam
Return FQN of network-ipam’s parent in list form.
Return FQN of network-ipam’s parent as colon delimted string.
Return tag list for network-ipam.
| Returns: | list of <Tag> |
|---|
Return object type (network-ipam).
Return virtual-DNS list for network-ipam.
| Returns: | list of <VirtualDns> |
|---|
Return list of all virtual-networks using this network-ipam
Return list of all virtual-routers using this network-ipam
Get id-perms for network-ipam.
| Returns: | IdPermsType object |
|---|
Get ipam-subnet-method for network-ipam.
| Returns: | SubnetMethodType object |
|---|
Get ipam-subnets for network-ipam.
| Returns: | IpamSubnets object |
|---|
Get ipam-subnetting for network-ipam.
| Returns: | xsd:boolean object |
|---|
Get network-ipam-mgmt for network-ipam.
| Returns: | IpamType object |
|---|
Get perms2 for network-ipam.
| Returns: | PermType2 object |
|---|
Set tag for network-ipam.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for network-ipam.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-DNS for network-ipam.
| Parameters: | ref_obj – VirtualDns object |
|---|
Set virtual-DNS list for network-ipam.
| Parameters: | ref_obj_list – list of VirtualDns object |
|---|
Bases: future.types.newobject.newobject
Network Policy is set access control rules that can be attached to virtual networks. Network ACL(s) and connectivity information is derived from Network policies that are attached to virtual networks.
Type: PolicyEntriesType
Created By: User (required)
Operations Allowed: CRUD
Description:
Network policy rule entries.
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 network-policy.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for network-policy.
| Returns: | KeyValuePairs object |
|---|
Get display-name for network-policy.
| Returns: | xsd:string object |
|---|
Display network-policy object in compact form.
Return FQN of network-policy in list form.
Return FQN of network-policy as colon delimited string.
Return FQN of network-policy’s parent in list form.
Return FQN of network-policy’s parent as colon delimted string.
Return list of all security-logging-objects using this network-policy
Return tag list for network-policy.
| Returns: | list of <Tag> |
|---|
Return object type (network-policy).
Return list of all virtual-networks using this network-policy
Get id-perms for network-policy.
| Returns: | IdPermsType object |
|---|
Get network-policy-entries for network-policy.
| Returns: | PolicyEntriesType object |
|---|
Get perms2 for network-policy.
| Returns: | PermType2 object |
|---|
Set tag for network-policy.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for network-policy.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Parent of this node resource.
Type: str, one-of [u’private’, u’baremetal’, u’esxi’, u’ovs-compute’, u’sriov-compute’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type of machine resource
Type: ESXIHostInfo
Created By: User (optional)
Operations Allowed: CRUD
Description:
Details of the ESXI host
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
IP Address of the Management interface
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Fully qualified host name
Type: BaremetalServerInfo
Created By: User (optional)
Operations Allowed: CRUD
Description:
Details of the baremetal server
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Provisioning Interface MAC Address
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Comma seperated disk partition to use.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Name of the Management interface
Type: CloudInstanceInfo
Created By: User (optional)
Operations Allowed: CRUD
Description:
Information related to cloud
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 matching node-profile object for this node
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add node-profile to node.
| Parameters: | ref_obj – NodeProfile object |
|---|
Add tag to node.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for node.
| Returns: | KeyValuePairs object |
|---|
Get bms-info for node.
| Returns: | BaremetalServerInfo object |
|---|
Get cloud-info for node.
| Returns: | CloudInstanceInfo object |
|---|
Get disk-partition for node.
| Returns: | xsd:string object |
|---|
Get display-name for node.
| Returns: | xsd:string object |
|---|
Display node object in compact form.
Get esxi-info for node.
| Returns: | ESXIHostInfo object |
|---|
Return FQN of node in list form.
Return FQN of node as colon delimited string.
Return node-profile list for node.
| Returns: | list of <NodeProfile> |
|---|
Return FQN of node’s parent in list form.
Return FQN of node’s parent as colon delimted string.
Return tag list for node.
| Returns: | list of <Tag> |
|---|
Return object type (node).
Get hostname for node.
| Returns: | xsd:string object |
|---|
Get id-perms for node.
| Returns: | IdPermsType object |
|---|
Get interface-name for node.
| Returns: | xsd:string object |
|---|
Get ip-address for node.
| Returns: | xsd:string object |
|---|
Get mac-address for node.
| Returns: | xsd:string object |
|---|
Get node_type for node.
| Returns: | NodeType object |
|---|
Get perms2 for node.
| Returns: | PermType2 object |
|---|
Set node-profile for node.
| Parameters: | ref_obj – NodeProfile object |
|---|
Set node-profile list for node.
| Parameters: | ref_obj_list – list of NodeProfile object |
|---|
Set tag for node.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for node.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Node profile contains the meta-data to profile/categorize the devices so that a list of supported capabilities/roles by the device are known to the system. For example, we can define a node profile to specify list of capabilities/roles supported by a set of QFX10K devices with certain hardware/software installed. It also contains the default config parameter values for each supported roles/capability. These are the config parameters that are not modeled in the VNC data model. They could be vendor specific config parameters that we allow user to tweak via API or some kind of auto generated UI from job template input schema. The UML diagram for node-profile can be found at https://github.com/jnpr-tjiang/cfm-data-model/blob/master/5.0.1-data-model/images/node_profile.png
- Created By:
- User
- Child of:
- GlobalSystemConfig object
- Properties:
- node_profile_type
Type: str, one-of [u’physical-router’, u’end-system’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Node profile type to differentiate the node profile network devices from server node profiles.
- node_profile_vendor
Type: str
Created By: User (required)
Operations Allowed: CRUD
Description:
Vendor name (e.g. Juniper) that this node profile can be used for.
- node_profile_device_family
Type: str
Created By: User (required)
Operations Allowed: CRUD
Description:
Device family name that this node profile can be used to match.
- node_profile_hitless_upgrade
Type: bool
Created By: User (required)
Operations Allowed: CRUD
Description:
if set to false, do not perform hitless image upgrade on devices using this node profile
- node_profile_roles
Type: NodeProfileRolesType
Created By: User (required)
Operations Allowed: CRUD
Description:
List of capable physical and routing-bridging role combinations supported by the devices that
matches one of the hardware list defined in this node profile.
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
- Children:
- list of RoleConfig objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of role configs for those physical or routing/bridging roles defined in the node-profile.
- References to:
- list of JobTemplate objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
This reference associates the node profile to a job-template that contains a playbook that generates
device specific role config and deploys it to the device. The role-config.config
attribtue value must be in JSON format and conform to the input_schema defined in the
job-template.
- list of Hardware objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Hardware info defined in a node profile that are used to categorize the devices
- list of RoleDefinition objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of role definitions supported for this node profile
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
- Referred by:
- list of Fabric objects
- list of PhysicalRouter objects
- list of Node objects
Add hardware to node-profile.
| Parameters: | ref_obj – Hardware object |
|---|
Add job-template to node-profile.
| Parameters: | ref_obj – JobTemplate object |
|---|
Add role-definition to node-profile.
| Parameters: | ref_obj – RoleDefinition object |
|---|
Add tag to node-profile.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for node-profile.
| Returns: | KeyValuePairs object |
|---|
Get display-name for node-profile.
| Returns: | xsd:string object |
|---|
Display node-profile object in compact form.
Return list of all fabrics using this node-profile
Return FQN of node-profile in list form.
Return FQN of node-profile as colon delimited string.
Return hardware list for node-profile.
| Returns: | list of <Hardware> |
|---|
Return job-template list for node-profile.
| Returns: | list of <JobTemplate> |
|---|
Return list of all nodes using this node-profile
Return FQN of node-profile’s parent in list form.
Return FQN of node-profile’s parent as colon delimted string.
Return list of all physical-routers using this node-profile
Return role-definition list for node-profile.
| Returns: | list of <RoleDefinition> |
|---|
Return tag list for node-profile.
| Returns: | list of <Tag> |
|---|
Return object type (node-profile).
Get id-perms for node-profile.
| Returns: | IdPermsType object |
|---|
Get node-profile-device-family for node-profile.
| Returns: | xsd:string object |
|---|
Get node-profile-hitless-upgrade for node-profile.
| Returns: | xsd:boolean object |
|---|
Get node-profile-roles for node-profile.
| Returns: | NodeProfileRolesType object |
|---|
Get node-profile-type for node-profile.
| Returns: | NodeProfileType object |
|---|
Get node-profile-vendor for node-profile.
| Returns: | xsd:string object |
|---|
Get perms2 for node-profile.
| Returns: | PermType2 object |
|---|
Set hardware for node-profile.
| Parameters: | ref_obj – Hardware object |
|---|
Set hardware list for node-profile.
| Parameters: | ref_obj_list – list of Hardware object |
|---|
Set job-template for node-profile.
| Parameters: | ref_obj – JobTemplate object |
|---|
Set job-template list for node-profile.
| Parameters: | ref_obj_list – list of JobTemplate object |
|---|
Set role-definition for node-profile.
| Parameters: | ref_obj – RoleDefinition object |
|---|
Set role-definition list for node-profile.
| Parameters: | ref_obj_list – list of RoleDefinition object |
|---|
Set tag for node-profile.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for node-profile.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Defines an overlay role
- Created By:
- User
- Child of:
- GlobalSystemConfig object
- Properties:
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
- Referred by:
- list of PhysicalRouter objects
- list of RoleDefinition objects
Add tag to overlay-role.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for overlay-role.
| Returns: | KeyValuePairs object |
|---|
Get display-name for overlay-role.
| Returns: | xsd:string object |
|---|
Display overlay-role object in compact form.
Return FQN of overlay-role in list form.
Return FQN of overlay-role as colon delimited string.
Return FQN of overlay-role’s parent in list form.
Return FQN of overlay-role’s parent as colon delimted string.
Return list of all physical-routers using this overlay-role
Return list of all role-definitions using this overlay-role
Return tag list for overlay-role.
| Returns: | list of <Tag> |
|---|
Return object type (overlay-role).
Get id-perms for overlay-role.
| Returns: | IdPermsType object |
|---|
Get perms2 for overlay-role.
| Returns: | PermType2 object |
|---|
Set tag for overlay-role.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for overlay-role.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Created By:
Type: str, one-of [u’public-peering’]
Created By: User (required)
Operations Allowed: CRUD
Description:
Peering policy service 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
Add tag to peering-policy.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for peering-policy.
| Returns: | KeyValuePairs object |
|---|
Get display-name for peering-policy.
| Returns: | xsd:string object |
|---|
Display peering-policy object in compact form.
Return list of all e2-service-providers using this peering-policy
Return FQN of peering-policy in list form.
Return FQN of peering-policy as colon delimited string.
Return tag list for peering-policy.
| Returns: | list of <Tag> |
|---|
Return object type (peering-policy).
Get id-perms for peering-policy.
| Returns: | IdPermsType object |
|---|
Get peering-service for peering-policy.
| Returns: | PeeringServiceType object |
|---|
Get perms2 for peering-policy.
| Returns: | PermType2 object |
|---|
Set tag for peering-policy.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for peering-policy.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Physical interfaces on physical routers.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Ethernet Segment Id configured for the Physical Interface. In a multihomed environment, user should
configure the peer Physical interface with the same ESI.
Type: str, one-of [u’regular’, u’lag’, u’service’, u’fabric’, u’access’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Physical interface type that can be either regular/LAG/service/fabric/access link.
Type: MacAddressesType
Created By: User (optional)
Operations Allowed: CRUD
Description:
MAC addresses on this physical interface.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
port id of this physical interface. This port id is used in LLDP to identify a physical port on the
peering device
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
User can enable this option to configure flow control on the physical interface.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
User can enable this option to make LACP up and running. This is applicable only on individual
member physical interfaces of a VPG.
Type: PortParameters
Created By: User (optional)
Operations Allowed: CRUD
Description:
User can select this option to configure port parameters such as description, MTU and port enable or
disable.
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:
Logical interfaces on physical interface on physical routers.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to the other physical interface that is connected to this physical interface.
Created By: User (optional)
Operations Allowed: CRUD
Description:
This link represents physical connection from access port of a switch to the server port
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add physical-interface to physical-interface.
| Parameters: | ref_obj – PhysicalInterface object |
|---|
Add port to physical-interface.
| Parameters: | ref_obj – Port object |
|---|
Add tag to physical-interface.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for physical-interface.
| Returns: | KeyValuePairs object |
|---|
Get display-name for physical-interface.
| Returns: | xsd:string object |
|---|
Display physical-interface object in compact form.
Get ethernet-segment-identifier for physical-interface.
| Returns: | xsd:string object |
|---|
Return FQN of physical-interface in list form.
Return FQN of physical-interface as colon delimited string.
Return list of all link-aggregation-groups using this physical-interface
Return FQN of physical-interface’s parent in list form.
Return FQN of physical-interface’s parent as colon delimted string.
Return list of all physical-interfaces using this physical-interface
Return physical-interface list for physical-interface.
| Returns: | list of <PhysicalInterface> |
|---|
Return port list for physical-interface.
| Returns: | list of <Port> |
|---|
Return list of all service-appliances using this physical-interface
Return tag list for physical-interface.
| Returns: | list of <Tag> |
|---|
Return object type (physical-interface).
Return list of all virtual-machine-interfaces using this physical-interface
Return list of all virtual-port-groups using this physical-interface
Get id-perms for physical-interface.
| Returns: | IdPermsType object |
|---|
Get perms2 for physical-interface.
| Returns: | PermType2 object |
|---|
Get physical-interface-flow-control for physical-interface.
| Returns: | xsd:boolean object |
|---|
Get physical-interface-lacp-force-up for physical-interface.
| Returns: | xsd:boolean object |
|---|
Get physical-interface-mac-addresses for physical-interface.
| Returns: | MacAddressesType object |
|---|
Get physical-interface-port-id for physical-interface.
| Returns: | xsd:string object |
|---|
Get physical-interface-port-params for physical-interface.
| Returns: | PortParameters object |
|---|
Get physical-interface-type for physical-interface.
| Returns: | PhysicalInterfaceType object |
|---|
Set physical-interface for physical-interface.
| Parameters: | ref_obj – PhysicalInterface object |
|---|
Set physical-interface list for physical-interface.
| Parameters: | ref_obj_list – list of PhysicalInterface object |
|---|
Set port for physical-interface.
| Parameters: | ref_obj – Port object |
|---|
Set port list for physical-interface.
| Parameters: | ref_obj_list – list of Port object |
|---|
Set tag for physical-interface.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for physical-interface.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Defines a physical role
- Created By:
- User
- Child of:
- GlobalSystemConfig object
- Properties:
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
- Referred by:
- list of DeviceFunctionalGroup objects
- list of PhysicalRouter objects
- list of RoleDefinition objects
Add tag to physical-role.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for physical-role.
| Returns: | KeyValuePairs object |
|---|
Get display-name for physical-role.
| Returns: | xsd:string object |
|---|
Display physical-role object in compact form.
Return list of all device-functional-groups using this physical-role
Return FQN of physical-role in list form.
Return FQN of physical-role as colon delimited string.
Return FQN of physical-role’s parent in list form.
Return FQN of physical-role’s parent as colon delimted string.
Return list of all physical-routers using this physical-role
Return list of all role-definitions using this physical-role
Return tag list for physical-role.
| Returns: | list of <Tag> |
|---|
Return object type (physical-role).
Get id-perms for physical-role.
| Returns: | IdPermsType object |
|---|
Get perms2 for physical-role.
| Returns: | PermType2 object |
|---|
Set tag for physical-role.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for physical-role.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Physical router object represent any physical device that participates in virtual networking, like routers, switches, servers, firewalls etc.
Type: JunosServicePorts
Created By: User (optional)
Operations Allowed: CRUD
Description:
Juniper JUNOS specific service interfaces name to perform services like NAT.
Type: TelemetryStateInfo
Created By: User (optional)
Operations Allowed: CRUD
Description:
Telemetry info of router. Check TelemetryStateInfo
Type: str
Created By: User (required)
Operations Allowed: CRUD
Description:
Device family that this physical router is part of. It is used by the device manager to choose the
device family specific Ansible playbooks for device management
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
os version for this physical router. It is updated when device is imported or device image is
successfully upgraded
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Device host name that can be either discovered during via fabric on-boarding workflow or manually
set by the user
Type: str, one-of xsd:string
Created By: User (required)
Operations Allowed: CRUD
Description:
Management ip for this physical router. It is used by the device manager to perform netconf and by
SNMP collector if enabled.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Management mac for this physical router.
Type: str, one-of xsd:string
Created By: User (optional)
Operations Allowed: CRUD
Description:
This is ip address in the ip-fabric(underlay) network that can be used in data plane by physical
router. Usually it is the VTEP address in VxLAN for the TOR switch.
Type: str, one-of xsd:string
Created By: User (optional)
Operations Allowed: CRUD
Description:
This is ip address of loopback interface of physical router. Used by the device manager to configure
physical router loopback interface.
Type: str, one-of xsd:string
Created By: User (optional)
Operations Allowed: CRUD
Description:
This is the loopback ip address for assisted replication. Used by the device manager to configure
physical router replicator ip.
Type: str
Created By: User (required)
Operations Allowed: CRUD
Description:
Vendor name of the physical router (e.g juniper). Used by the device manager to select driver.
Type: str
Created By: User (required)
Operations Allowed: CRUD
Description:
Model name of the physical router (e.g juniper). Used by the device manager to select driver.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Serial number for the physical device that is used by device manager to identify the device during
device discovery.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
This physical router is enabled to be configured by device manager.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Set to true if underlay is configured by device manager. The greenfield ZTP workflow sets this
attribute to true. The brownfield on-boarding sets this attribute to false.
Type: str, one-of [u’spine’, u’leaf’, u’e2-access’, u’e2-provider’, u’e2-internet’, u’e2-vrr’, u’pnf’, u’superspine’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Physical router role (e.g spine or leaf), used by the device manager to provision physical router,
for e.g device manager may choose to configure physical router based on its role.
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.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
SNMP support on this router
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
LLDP support on this router
Type: UserCredentials
Created By: User (optional)
Operations Allowed: CRUD
Description:
Username and password for netconf to the physical router by device manager.
Type: str, one-of [u’none’, u’local’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type of encryption used for physical-router-user-credentials.
Type: SNMPCredentials
Created By: User (optional)
Operations Allowed: CRUD
Description:
SNMP credentials for the physical router used by SNMP collector.
Type: DnsmasqLeaseParameters
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dnsmasq lease parameters for the physical router.
Type: str, one-of [u’in_sync’, u’out_of_sync’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
CLI commit state for the physical router. Used to check if device is in sync with Contrail managed
configs
Type: str, one-of [u’dhcp’, u’rma’, u’activating’, u’active’, u’maintenance’, u’error’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Managed state for the physical router. Used to RMA devices
Type: str, one-of [u’discovered’, u’interfaces_onboarded’, u’topology_discovered’, u’role_discovered’, u’underlay_configured’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Onboarding state for the physical router. These states are updated during the ZTP/Brownfield of the
device such as discovered, interface onboarded, topology discovered, underlay configured and others
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Brownfield device underlay configuration stored during underlay onboarding. Only valid if physical-
router-underlay-managed is false
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Supplemental configuration stored during ZTP onboarding.
Type: AutonomousSystemsType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Autonomous system configured on the device represented by the physical router.
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 link aggregation groups on this PRouter.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Hardware Inventory on a physical router.
Created By: User (optional)
Operations Allowed: CRUD
Description:
CLI commits done on a physical router.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Physical interfaces on physical routers.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Logical interfaces on physical routers.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to vrouter responsible for this physical router. Currently only applicable for vrouters
that are TOR agents.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to BGP peer representing this physical router.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to virtual network, whose VRF is present on this physical router, Applicable when only VRF
is present with no physical interfaces from this physical vrouter. Generally used when using device
manager and option A+B for this virtual network in L3VPN use case.
Created By: User (optional)
Operations Allowed: CRUD
Description:
The Physical Routers on which the config needs to be pushed
Created By: User (optional)
Operations Allowed: CRUD
Description:
Fabric that this physical-router belongs to.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Node profile assigned to the physical router during device discovery/onboarding.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Device functional group that this physical-router belongs to.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Device Chassis info assigned to the physical router during device discovery/onboarding.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Intended device image for this PRouter. Each PRouter can have one and only one device image
assigned. If this image is successfully installed on the PRouter, the PRouterUVE.os_version should
match the os-version property of the image
Created By: User (optional)
Operations Allowed: CRUD
Description:
Physical role assigned to this physical router
Created By: User (optional)
Operations Allowed: CRUD
Description:
Overlay roles assigned to this physical router
Created By: User (optional)
Operations Allowed: CRUD
Description:
Telemetry profile assigned to the physical router by user. Each physical router is associated with
only one telemetry profile.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add bgp-router to physical-router.
| Parameters: | ref_obj – BgpRouter object |
|---|
Add device-chassis to physical-router.
| Parameters: | ref_obj – DeviceChassis object |
|---|
Add device-functional-group to physical-router.
| Parameters: | ref_obj – DeviceFunctionalGroup object |
|---|
Add device-image to physical-router.
| Parameters: | ref_obj – DeviceImage object |
|---|
Add fabric to physical-router.
| Parameters: | ref_obj – Fabric object |
|---|
Add intent-map to physical-router.
| Parameters: | ref_obj – IntentMap object |
|---|
Add node-profile to physical-router.
| Parameters: | ref_obj – NodeProfile object |
|---|
Add overlay-role to physical-router.
| Parameters: | ref_obj – OverlayRole object |
|---|
Add physical-role to physical-router.
| Parameters: | ref_obj – PhysicalRole object |
|---|
Add tag to physical-router.
| Parameters: | ref_obj – Tag object |
|---|
Add telemetry-profile to physical-router.
| Parameters: | ref_obj – TelemetryProfile object |
|---|
Add virtual-network to physical-router.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Add virtual-router to physical-router.
| Parameters: | ref_obj – VirtualRouter object |
|---|
Get annotations for physical-router.
| Returns: | KeyValuePairs object |
|---|
Get display-name for physical-router.
| Returns: | xsd:string object |
|---|
Display physical-router object in compact form.
Return bgp-router list for physical-router.
| Returns: | list of <BgpRouter> |
|---|
Return device-chassis list for physical-router.
| Returns: | list of <DeviceChassis> |
|---|
Return device-functional-group list for physical-router.
| Returns: | list of <DeviceFunctionalGroup> |
|---|
Return device-image list for physical-router.
| Returns: | list of <DeviceImage> |
|---|
Return list of all e2-service-providers using this physical-router
Return fabric list for physical-router.
| Returns: | list of <Fabric> |
|---|
Return FQN of physical-router in list form.
Return FQN of physical-router as colon delimited string.
Return list of all instance-ips using this physical-router
Return intent-map list for physical-router.
| Returns: | list of <IntentMap> |
|---|
Return list of all logical-routers using this physical-router
Return list of all network-device-configs using this physical-router
Return node-profile list for physical-router.
| Returns: | list of <NodeProfile> |
|---|
Return overlay-role list for physical-router.
| Returns: | list of <OverlayRole> |
|---|
Return FQN of physical-router’s parent in list form.
Return FQN of physical-router’s parent as colon delimted string.
Return physical-role list for physical-router.
| Returns: | list of <PhysicalRole> |
|---|
Return list of all service-endpoints using this physical-router
Return tag list for physical-router.
| Returns: | list of <Tag> |
|---|
Return telemetry-profile list for physical-router.
| Returns: | list of <TelemetryProfile> |
|---|
Return object type (physical-router).
Return virtual-network list for physical-router.
| Returns: | list of <VirtualNetwork> |
|---|
Return virtual-router list for physical-router.
| Returns: | list of <VirtualRouter> |
|---|
Get id-perms for physical-router.
| Returns: | IdPermsType object |
|---|
Get perms2 for physical-router.
| Returns: | PermType2 object |
|---|
Get physical-router-autonomous-system for physical-router.
| Returns: | AutonomousSystemsType object |
|---|
Get physical-router-cli-commit-state for physical-router.
| Returns: | CommitStateType object |
|---|
Get physical-router-dataplane-ip for physical-router.
| Returns: | IpAddress object |
|---|
Get physical-router-device-family for physical-router.
| Returns: | xsd:string object |
|---|
Get physical-router-dhcp-parameters for physical-router.
| Returns: | DnsmasqLeaseParameters object |
|---|
Get physical-router-encryption-type for physical-router.
| Returns: | CredentialEncryptionType object |
|---|
Get physical-router-hostname for physical-router.
| Returns: | xsd:string object |
|---|
Get physical-router-junos-service-ports for physical-router.
| Returns: | JunosServicePorts object |
|---|
Get physical-router-lldp for physical-router.
| Returns: | xsd:boolean object |
|---|
Get physical-router-loopback-ip for physical-router.
| Returns: | IpAddress object |
|---|
Get physical-router-managed-state for physical-router.
| Returns: | ManagedStateType object |
|---|
Get physical-router-management-ip for physical-router.
| Returns: | IpAddress object |
|---|
Get physical-router-management-mac for physical-router.
| Returns: | xsd:string object |
|---|
Get physical-router-onboarding-state for physical-router.
| Returns: | OnboardingStateType object |
|---|
Get physical-router-os-version for physical-router.
| Returns: | xsd:string object |
|---|
Get physical-router-product-name for physical-router.
| Returns: | xsd:string object |
|---|
Get physical-router-replicator-loopback-ip for physical-router.
| Returns: | IpAddress object |
|---|
Get physical-router-role for physical-router.
| Returns: | PhysicalRouterRole object |
|---|
Get physical-router-serial-number for physical-router.
| Returns: | xsd:string object |
|---|
Get physical-router-snmp for physical-router.
| Returns: | xsd:boolean object |
|---|
Get physical-router-snmp-credentials for physical-router.
| Returns: | SNMPCredentials object |
|---|
Get physical-router-supplemental-config for physical-router.
| Returns: | xsd:string object |
|---|
Get physical-router-underlay-config for physical-router.
| Returns: | xsd:string object |
|---|
Get physical-router-underlay-managed for physical-router.
| Returns: | xsd:boolean object |
|---|
Get physical-router-user-credentials for physical-router.
| Returns: | UserCredentials object |
|---|
Get physical-router-vendor-name for physical-router.
| Returns: | xsd:string object |
|---|
Get physical-router-vnc-managed for physical-router.
| Returns: | xsd:boolean object |
|---|
Get routing-bridging-roles for physical-router.
| Returns: | RoutingBridgingRolesType object |
|---|
Set bgp-router for physical-router.
| Parameters: | ref_obj – BgpRouter object |
|---|
Set bgp-router list for physical-router.
| Parameters: | ref_obj_list – list of BgpRouter object |
|---|
Set device-chassis for physical-router.
| Parameters: | ref_obj – DeviceChassis object |
|---|
Set device-chassis list for physical-router.
| Parameters: | ref_obj_list – list of DeviceChassis object |
|---|
Set device-functional-group for physical-router.
| Parameters: | ref_obj – DeviceFunctionalGroup object |
|---|
Set device-functional-group list for physical-router.
| Parameters: | ref_obj_list – list of DeviceFunctionalGroup object |
|---|
Set device-image for physical-router.
| Parameters: | ref_obj – DeviceImage object |
|---|
Set device-image list for physical-router.
| Parameters: | ref_obj_list – list of DeviceImage object |
|---|
Set fabric for physical-router.
| Parameters: | ref_obj – Fabric object |
|---|
Set fabric list for physical-router.
| Parameters: | ref_obj_list – list of Fabric object |
|---|
Set intent-map for physical-router.
| Parameters: | ref_obj – IntentMap object |
|---|
Set intent-map list for physical-router.
| Parameters: | ref_obj_list – list of IntentMap object |
|---|
Set node-profile for physical-router.
| Parameters: | ref_obj – NodeProfile object |
|---|
Set node-profile list for physical-router.
| Parameters: | ref_obj_list – list of NodeProfile object |
|---|
Set overlay-role for physical-router.
| Parameters: | ref_obj – OverlayRole object |
|---|
Set overlay-role list for physical-router.
| Parameters: | ref_obj_list – list of OverlayRole object |
|---|
Set physical-role for physical-router.
| Parameters: | ref_obj – PhysicalRole object |
|---|
Set physical-role list for physical-router.
| Parameters: | ref_obj_list – list of PhysicalRole object |
|---|
Set tag for physical-router.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for physical-router.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set telemetry-profile for physical-router.
| Parameters: | ref_obj – TelemetryProfile object |
|---|
Set telemetry-profile list for physical-router.
| Parameters: | ref_obj_list – list of TelemetryProfile object |
|---|
Set virtual-network for physical-router.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Set virtual-network list for physical-router.
| Parameters: | ref_obj_list – list of VirtualNetwork object |
|---|
Set virtual-router for physical-router.
| Parameters: | ref_obj – VirtualRouter object |
|---|
Set virtual-router list for physical-router.
| Parameters: | ref_obj_list – list of VirtualRouter object |
|---|
Get telemetry-info for physical-router.
| Returns: | TelemetryStateInfo object |
|---|
Bases: future.types.newobject.newobject
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:
Service Group object
Created By: User (optional)
Operations Allowed: CRUD
Description:
Address Group object
Created By: User (optional)
Operations Allowed: CRUD
Description:
Firewall-rule object
Created By: User (optional)
Operations Allowed: CRUD
Description:
firewall-policy object consisting of one or more firewall rules
Created By: User (optional)
Operations Allowed: CRUD
Description:
Application-policy object defining policies to apply for a given application tag
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to policy-management.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for policy-management.
| Returns: | KeyValuePairs object |
|---|
Get display-name for policy-management.
| Returns: | xsd:string object |
|---|
Display policy-management object in compact form.
Return FQN of policy-management in list form.
Return FQN of policy-management as colon delimited string.
Return FQN of policy-management’s parent in list form.
Return FQN of policy-management’s parent as colon delimted string.
Return tag list for policy-management.
| Returns: | list of <Tag> |
|---|
Return object type (policy-management).
Get id-perms for policy-management.
| Returns: | IdPermsType object |
|---|
Get perms2 for policy-management.
| Returns: | PermType2 object |
|---|
Set tag for policy-management.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for policy-management.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Parent of this port.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
UUID of the port group in which this port belongs
Type: BaremetalPortInfo
Created By: User (optional)
Operations Allowed: CRUD
Description:
Details of the baremetal server port
Type: ESXIProperties
Created By: User (optional)
Operations Allowed: CRUD
Description:
Information related to Port-ESXi/vCenter
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Label of the interface representing the use of the interface.
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 port.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for port.
| Returns: | KeyValuePairs object |
|---|
Get bms-port-info for port.
| Returns: | BaremetalPortInfo object |
|---|
Get display-name for port.
| Returns: | xsd:string object |
|---|
Display port object in compact form.
Get esxi-port-info for port.
| Returns: | ESXIProperties object |
|---|
Return FQN of port in list form.
Return FQN of port as colon delimited string.
Return FQN of port’s parent in list form.
Return FQN of port’s parent as colon delimted string.
Return list of all physical-interfaces using this port
Return list of all port-groups using this port
Return tag list for port.
| Returns: | list of <Tag> |
|---|
Return object type (port).
Get id-perms for port.
| Returns: | IdPermsType object |
|---|
Get label for port.
| Returns: | xsd:string object |
|---|
Get perms2 for port.
| Returns: | PermType2 object |
|---|
Get port-group-uuid for port.
| Returns: | xsd:string object |
|---|
Set tag for port.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for port.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Parent of this port group.
Type: BaremetalPortGroupInfo
Created By: User (optional)
Operations Allowed: CRUD
Description:
Details of the baremetal server port 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:
Referred by:
Add port to port-group.
| Parameters: | ref_obj – Port object |
|---|
Add tag to port-group.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for port-group.
| Returns: | KeyValuePairs object |
|---|
Get bms-port-group-info for port-group.
| Returns: | BaremetalPortGroupInfo object |
|---|
Get display-name for port-group.
| Returns: | xsd:string object |
|---|
Display port-group object in compact form.
Return FQN of port-group in list form.
Return FQN of port-group as colon delimited string.
Return FQN of port-group’s parent in list form.
Return FQN of port-group’s parent as colon delimted string.
Return port list for port-group.
| Returns: | list of <Port> |
|---|
Return tag list for port-group.
| Returns: | list of <Tag> |
|---|
Return object type (port-group).
Get id-perms for port-group.
| Returns: | IdPermsType object |
|---|
Get perms2 for port-group.
| Returns: | PermType2 object |
|---|
Set port for port-group.
| Parameters: | ref_obj – Port object |
|---|
Set port list for port-group.
| Parameters: | ref_obj_list – list of Port object |
|---|
Set tag for port-group.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for port-group.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Encapsulates port configurations like storm control, QoS etc
- Created By:
- User
- Child of:
- Project object
- Properties:
- port_profile_params
Type: PortProfileParameters
Created By: User (optional)
Operations Allowed: CRUD
Description:
This is to configure port attributes.
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of StormControlProfile objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Storm control profile that this port profile uses.
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
- Referred by:
- list of VirtualMachineInterface objects
- list of VirtualPortGroup objects
Add storm-control-profile to port-profile.
| Parameters: | ref_obj – StormControlProfile object |
|---|
Add tag to port-profile.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for port-profile.
| Returns: | KeyValuePairs object |
|---|
Get display-name for port-profile.
| Returns: | xsd:string object |
|---|
Display port-profile object in compact form.
Return FQN of port-profile in list form.
Return FQN of port-profile as colon delimited string.
Return FQN of port-profile’s parent in list form.
Return FQN of port-profile’s parent as colon delimted string.
Return storm-control-profile list for port-profile.
| Returns: | list of <StormControlProfile> |
|---|
Return tag list for port-profile.
| Returns: | list of <Tag> |
|---|
Return object type (port-profile).
Return list of all virtual-machine-interfaces using this port-profile
Return list of all virtual-port-groups using this port-profile
Get id-perms for port-profile.
| Returns: | IdPermsType object |
|---|
Get perms2 for port-profile.
| Returns: | PermType2 object |
|---|
Get port-profile-params for port-profile.
| Returns: | PortProfileParameters object |
|---|
Set storm-control-profile for port-profile.
| Parameters: | ref_obj – StormControlProfile object |
|---|
Set storm-control-profile list for port-profile.
| Parameters: | ref_obj_list – list of StormControlProfile object |
|---|
Set tag for port-profile.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for port-profile.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Port tuples are ordered set of interfaces that represent a service virtual machine or physical device , which is part of this service instance. Order of interfaces in port tuple is same as specified in the service template. example SI = [(Left, Right, Management), (L, R, M), ..., (L, R, M)].
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 tenant logical routers to be attached to the service left or right attachment point
Created By: User (optional)
Operations Allowed: CRUD
Description:
Internal virtual networks for PNF left or right service attachment points are used to internally to
allocate route targets for the left and right service VRFs on the spine device
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add logical-router to port-tuple.
| Parameters: | ref_obj – LogicalRouter object |
|---|
Add tag to port-tuple.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-network to port-tuple.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Get annotations for port-tuple.
| Returns: | KeyValuePairs object |
|---|
Get display-name for port-tuple.
| Returns: | xsd:string object |
|---|
Display port-tuple object in compact form.
Return FQN of port-tuple in list form.
Return FQN of port-tuple as colon delimited string.
Return logical-router list for port-tuple.
| Returns: | list of <LogicalRouter> |
|---|
Return FQN of port-tuple’s parent in list form.
Return FQN of port-tuple’s parent as colon delimted string.
Return tag list for port-tuple.
| Returns: | list of <Tag> |
|---|
Return object type (port-tuple).
Return list of all virtual-machine-interfaces using this port-tuple
Return virtual-network list for port-tuple.
| Returns: | list of <VirtualNetwork> |
|---|
Get id-perms for port-tuple.
| Returns: | IdPermsType object |
|---|
Get perms2 for port-tuple.
| Returns: | PermType2 object |
|---|
Set logical-router for port-tuple.
| Parameters: | ref_obj – LogicalRouter object |
|---|
Set logical-router list for port-tuple.
| Parameters: | ref_obj_list – list of LogicalRouter object |
|---|
Set tag for port-tuple.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for port-tuple.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-network for port-tuple.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Set virtual-network list for port-tuple.
| Parameters: | ref_obj_list – list of VirtualNetwork object |
|---|
Bases: future.types.newobject.newobject
Project represent one instance of application or tenant.
Type: QuotaType
Created By: User (required)
Operations Allowed: CRUD
Description:
Max instances limits for various objects under project.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
When this knob is enabled for a project, an internal system VN (VN-Int) is created for every logical
router in the project.
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: bool
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Security logging object configuration for specifying session logging criteria
Created By: User (optional)
Operations Allowed: CRUD
Description:
Security Groups are set of state full access control rules attached to interfaces.It can be used to
implement microsegmentation.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Virtual network is collection of end points (interface or ip(s) or MAC(s)) that can talk to each
other by default. It is collection of subnets connected by implicit router which default gateway in
each subnet.
Created By: User (optional)
Operations Allowed: CRUDQOS configuration specifying marking and queuing value for various QoS values
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
IP Address Management object that controls, ip allocation, DNS and DHCP
Created By: User (optional)
Operations Allowed: CRUD
Description:
Network Policy is set access control rules that can be attached to virtual networks. Network ACL(s)
and connectivity information is derived from Network policies that are attached to virtual networks.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Virtual machine interface represent a interface(port) into virtual network. It may or may not have
corresponding virtual machine. A virtual machine interface has atleast a MAC address and Ip address.
Created By: User (optional)
Operations Allowed: CRUD
Description:
BGP as service object represents BGP peer in the virtual network that can participate in dynamic
routing with implicit default gateway of the virtual network.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of references of child routing policy objects. automatically maintained by system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of references of child routing route aggregate objects. automatically maintained by system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Service instance represents logical instance service used in the virtual world, e.g. firewall, load
balancer etc. It can represent one or multiple virtual machines or physical devices. Many service
instances can share a virtual machine or physical device.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Service health check is a keepalive mechanism for the virtual machine interface. Liveliness of the
interface is determined based on configuration in the service health check. It is mainly designed
for service instance interfaces. However it will work with any interface which present on contrail
vrouter.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Network route table is mechanism of adding static routes in the virtual network
Created By: User (optional)
Operations Allowed: CRUD
Description:
Interface route table is mechanism to add static routes pointing to this interface.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Logical router is a mechanism to connect multiple virtual network as they have been connected by a
router.
Created By: User (optional)
Operations Allowed: CRUD
Description:
API access list is list of rules that define role based access to each API and its properties at
project level.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of references of child multicast policy objects. automatically maintained by system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Loadbalancer pool object represent set(pool) member servers which needs load balancing.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Health monitor objects is configuration to monitor health of individual pool members.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Virtual ip object application(protocol, port). Applicable only to LBaaS V1
Created By: User (optional)
Operations Allowed: CRUD
Description:
Listener represents the application(protocol, port) to be load balanced.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Loadbalancer object represents a LBaaS instance. One single Virtual IP and multiple (listeners,
pools). Applicable to LBaaS V2.
Created By: User (optional)
Operations Allowed: CR
Description:
BGP VPN resource contains a set of parameters for a BGP-based VPN
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of alarms that are applicable to objects anchored under the project.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Project level policy-management object re-grouping project policy resources
Created By: User (optional)
Operations Allowed: CRUD
Description:
Project level service Group object
Created By: User (optional)
Operations Allowed: CRUD
Description:
Project level address Group object
Created By: User (optional)
Operations Allowed: CRUD
Description:
Project level firewall-rule object
Created By: User (optional)
Operations Allowed: CRUD
Description:
Project level firewall-policy object consisting of one or more firewall rules
Created By: User (optional)
Operations Allowed: CRUD
Description:
Project level application-policy object defining policies to apply for a given application tag
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:
List of device functional groups in this project.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of virtual port groups/trunk ports in this project.
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of telemetry profiles supported under the project.
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of sflow profiles supported under the project.
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of grpc profiles supported under the project.
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of snmp profiles supported under the project.
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of netconf profiles supported under the project.
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of storm control profiles supported.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Encapsulates port configurations like storm control etc
Created By: User (optional)
Operations Allowed: CRUD
Description:
Project level host based service.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of structured-syslog-config that are applicable to objects anchored under project.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to network namespace of this project.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Deprecated as it is not needed. Will be removed in future.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to alias ip pool in this project.
Created By: System
Operations Allowed: CRUD
Description:
Reference to default application-policy-set is automatically created by system for default socped
application policy sets. Needed by vrouter to identify default application-policy-set rules of a
virtual machine interface
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add alias-ip-pool to project.
| Parameters: | ref_obj – AliasIpPool object |
|---|
Add application-policy-set to project.
| Parameters: | ref_obj – ApplicationPolicySet object |
|---|
Add floating-ip-pool to project.
| Parameters: | ref_obj – FloatingIpPool object |
|---|
Add namespace to project.
| Parameters: |
|
|---|
Add tag to project.
| Parameters: | ref_obj – Tag object |
|---|
Get alarm-enable for project.
| Returns: | xsd:boolean object |
|---|
Get annotations for project.
| Returns: | KeyValuePairs object |
|---|
Get display-name for project.
| Returns: | xsd:string object |
|---|
Display project object in compact form.
Get enable-security-policy-draft for project.
| Returns: | xsd:boolean object |
|---|
Return list of all alias-ips using this project
Return alias-ip-pool list for project.
| Returns: | list of <AliasIpPool> |
|---|
Return application-policy-set list for project.
| Returns: | list of <ApplicationPolicySet> |
|---|
Return list of all floating-ips using this project
Return floating-ip-pool list for project.
| Returns: | list of <FloatingIpPool> |
|---|
Return FQN of project in list form.
Return FQN of project as colon delimited string.
Return namespace list for project.
| Returns: | list of tuple <Namespace, SubnetType> |
|---|
Return FQN of project’s parent in list form.
Return FQN of project’s parent as colon delimted string.
Return tag list for project.
| Returns: | list of <Tag> |
|---|
Return object type (project).
Get id-perms for project.
| Returns: | IdPermsType object |
|---|
Get perms2 for project.
| Returns: | PermType2 object |
|---|
Get quota for project.
| Returns: | QuotaType object |
|---|
Set alias-ip-pool for project.
| Parameters: | ref_obj – AliasIpPool object |
|---|
Set alias-ip-pool list for project.
| Parameters: | ref_obj_list – list of AliasIpPool object |
|---|
Set application-policy-set for project.
| Parameters: | ref_obj – ApplicationPolicySet object |
|---|
Set application-policy-set list for project.
| Parameters: | ref_obj_list – list of ApplicationPolicySet object |
|---|
Set floating-ip-pool for project.
| Parameters: | ref_obj – FloatingIpPool object |
|---|
Set floating-ip-pool list for project.
| Parameters: | ref_obj_list – list of FloatingIpPool object |
|---|
Set namespace for project.
| Parameters: |
|
|---|
Set namespace list for project.
| Parameters: |
|
|---|
Set tag for project.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for project.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get vxlan-routing for project.
| Returns: | xsd:boolean 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.
Children:
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 tag to provider-attachment.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-router to provider-attachment.
| Parameters: | ref_obj – VirtualRouter object |
|---|
Get annotations for provider-attachment.
| Returns: | KeyValuePairs object |
|---|
Get display-name for provider-attachment.
| Returns: | xsd:string object |
|---|
Display provider-attachment object in compact form.
Return FQN of provider-attachment in list form.
Return FQN of provider-attachment as colon delimited string.
Return tag list for provider-attachment.
| Returns: | list of <Tag> |
|---|
Return object type (provider-attachment).
Return virtual-router list for provider-attachment.
| Returns: | list of <VirtualRouter> |
|---|
Get id-perms for provider-attachment.
| Returns: | IdPermsType object |
|---|
Get perms2 for provider-attachment.
| Returns: | PermType2 object |
|---|
Set tag for provider-attachment.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for provider-attachment.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-router for provider-attachment.
| Parameters: | ref_obj – VirtualRouter object |
|---|
Set virtual-router list for provider-attachment.
| Parameters: | ref_obj_list – list of VirtualRouter object |
|---|
Bases: future.types.newobject.newobject
When parent is project:
Type: str, one-of [u’vhost’, u’fabric’, u’project’]
Created By: User (required)
Operations Allowed: CRUD
Description:
Specifies if qos-config is for vhost, fabric or for project.
Type: QosIdForwardingClassPairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Map of DSCP match condition and applicable forwarding class for packet.
Type: QosIdForwardingClassPairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Map of .1p priority code to applicable forwarding class for packet.
Type: QosIdForwardingClassPairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Map of MPLS EXP values to applicable forwarding class for packet.
Type: int, within [0, 255]
Created By: User (required)
Operations Allowed: CRUD
Description:
Default forwarding class used for all non-specified QOS bits
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: System
Operations Allowed: CR
Description:
This link is internally created and may be removed in future. End users should not set this link or
assume it to be there
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add global-system-config to qos-config.
| Parameters: | ref_obj – GlobalSystemConfig object |
|---|
Add tag to qos-config.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for qos-config.
| Returns: | KeyValuePairs object |
|---|
Get default-forwarding-class-id for qos-config.
| Returns: | ForwardingClassId object |
|---|
Get display-name for qos-config.
| Returns: | xsd:string object |
|---|
Get dscp-entries for qos-config.
| Returns: | QosIdForwardingClassPairs object |
|---|
Display qos-config object in compact form.
Return FQN of qos-config in list form.
Return FQN of qos-config as colon delimited string.
Return global-system-config list for qos-config.
| Returns: | list of <GlobalSystemConfig> |
|---|
Return FQN of qos-config’s parent in list form.
Return FQN of qos-config’s parent as colon delimted string.
Return tag list for qos-config.
| Returns: | list of <Tag> |
|---|
Return object type (qos-config).
Return list of all virtual-machine-interfaces using this qos-config
Return list of all virtual-networks using this qos-config
Get id-perms for qos-config.
| Returns: | IdPermsType object |
|---|
Get mpls-exp-entries for qos-config.
| Returns: | QosIdForwardingClassPairs object |
|---|
Get perms2 for qos-config.
| Returns: | PermType2 object |
|---|
Get qos-config-type for qos-config.
| Returns: | QosConfigType object |
|---|
Set global-system-config for qos-config.
| Parameters: | ref_obj – GlobalSystemConfig object |
|---|
Set global-system-config list for qos-config.
| Parameters: | ref_obj_list – list of GlobalSystemConfig object |
|---|
Set tag for qos-config.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for qos-config.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get vlan-priority-entries for qos-config.
| Returns: | QosIdForwardingClassPairs object |
|---|
Bases: future.types.newobject.newobject
QOS queue config object in this project.
Type: int
Created By: User (required)
Operations Allowed: CRUD
Description:
Minimum bandwidth for this queue.
Type: int
Created By: User (required)
Operations Allowed: CRUD
Description:
Maximum bandwidth for this queue.
Type: int
Created By: User (required)
Operations Allowed: CRUD
Description:
Unique id for this queue.
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 qos-queue.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for qos-queue.
| Returns: | KeyValuePairs object |
|---|
Get display-name for qos-queue.
| Returns: | xsd:string object |
|---|
Display qos-queue object in compact form.
Return list of all forwarding-classs using this qos-queue
Return FQN of qos-queue in list form.
Return FQN of qos-queue as colon delimited string.
Return FQN of qos-queue’s parent in list form.
Return FQN of qos-queue’s parent as colon delimted string.
Return tag list for qos-queue.
| Returns: | list of <Tag> |
|---|
Return object type (qos-queue).
Get id-perms for qos-queue.
| Returns: | IdPermsType object |
|---|
Get max-bandwidth for qos-queue.
| Returns: | xsd:integer object |
|---|
Get min-bandwidth for qos-queue.
| Returns: | xsd:integer object |
|---|
Get perms2 for qos-queue.
| Returns: | PermType2 object |
|---|
Get qos-queue-identifier for qos-queue.
| Returns: | xsd:integer object |
|---|
Set tag for qos-queue.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for qos-queue.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
This resource exposes to users additional parameters to configure a specify physical or routing/switching roles. These are the config parameters that are mot modeled in VNC data model and we don’t want to hard code in the fabric ansible playbooks. These could be vendor specific parameters or could be extended by the field or customer who might want to tweak the playbooks. The schema for the role config are defined in the job-template.input_schema. This schema could be used by the UI to generically render the form for user to edit the config.
- Created By:
- User
- Child of:
- NodeProfile object
- Properties:
- role_config_config
Type: str
Created By: User (required)
Operations Allowed: CRUD
Description:
role config in JSON format. This JSON config must conform to the input-schema of the job template
for the role provisioning.
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to role-config.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for role-config.
| Returns: | KeyValuePairs object |
|---|
Get display-name for role-config.
| Returns: | xsd:string object |
|---|
Display role-config object in compact form.
Return FQN of role-config in list form.
Return FQN of role-config as colon delimited string.
Return FQN of role-config’s parent in list form.
Return FQN of role-config’s parent as colon delimted string.
Return tag list for role-config.
| Returns: | list of <Tag> |
|---|
Return object type (role-config).
Get id-perms for role-config.
| Returns: | IdPermsType object |
|---|
Get perms2 for role-config.
| Returns: | PermType2 object |
|---|
Get role-config-config for role-config.
| Returns: | xsd:string object |
|---|
Set tag for role-config.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for role-config.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Defines a role combination which comprises of a physical role and overlay role and the features associated with it.
- Created By:
- User
- Child of:
- GlobalSystemConfig object
- Properties:
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
- Children:
- list of FeatureConfig objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of feature configs for this role definition.
- References to:
- list of Feature objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of features for this role definition.
- list of PhysicalRole objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
physical role for this role definition.
- list of OverlayRole objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
overlay role for this role definition.
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
- Referred by:
- list of NodeProfile objects
Add feature to role-definition.
| Parameters: | ref_obj – Feature object |
|---|
Add overlay-role to role-definition.
| Parameters: | ref_obj – OverlayRole object |
|---|
Add physical-role to role-definition.
| Parameters: | ref_obj – PhysicalRole object |
|---|
Add tag to role-definition.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for role-definition.
| Returns: | KeyValuePairs object |
|---|
Get display-name for role-definition.
| Returns: | xsd:string object |
|---|
Display role-definition object in compact form.
Return feature list for role-definition.
| Returns: | list of <Feature> |
|---|
Return FQN of role-definition in list form.
Return FQN of role-definition as colon delimited string.
Return list of all node-profiles using this role-definition
Return overlay-role list for role-definition.
| Returns: | list of <OverlayRole> |
|---|
Return FQN of role-definition’s parent in list form.
Return FQN of role-definition’s parent as colon delimted string.
Return physical-role list for role-definition.
| Returns: | list of <PhysicalRole> |
|---|
Return tag list for role-definition.
| Returns: | list of <Tag> |
|---|
Return object type (role-definition).
Get id-perms for role-definition.
| Returns: | IdPermsType object |
|---|
Get perms2 for role-definition.
| Returns: | PermType2 object |
|---|
Set feature for role-definition.
| Parameters: | ref_obj – Feature object |
|---|
Set feature list for role-definition.
| Parameters: | ref_obj_list – list of Feature object |
|---|
Set overlay-role for role-definition.
| Parameters: | ref_obj – OverlayRole object |
|---|
Set overlay-role list for role-definition.
| Parameters: | ref_obj_list – list of OverlayRole object |
|---|
Set physical-role for role-definition.
| Parameters: | ref_obj – PhysicalRole object |
|---|
Set physical-role list for role-definition.
| Parameters: | ref_obj_list – list of PhysicalRole object |
|---|
Set tag for role-definition.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for role-definition.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
List of references of child routing route aggregate objects. automatically maintained by system.
Type: RouteListType
Created By: User (required)
Operations Allowed: CRUD
Description:
List of ip prefix (aggregate route prefix) for which aggregate route will be advertised. This
aggregate route is advertised if a matching(longest prefix match) prefix is found.
Type: str
Created By: User (required)
Operations Allowed: CRUD
Description:
Next for aggregate route that will be advertised.
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 route-aggregate policy attached to (service instance, interface).
Created By: System
Operations Allowed: CRUD
Description:
Reference to internal routing instance object automatically generated by system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add routing-instance to route-aggregate.
| Parameters: | ref_obj – RoutingInstance object |
|---|
Add service-instance to route-aggregate.
| Parameters: |
|
|---|
Add tag to route-aggregate.
| Parameters: | ref_obj – Tag object |
|---|
Get aggregate-route-entries for route-aggregate.
| Returns: | RouteListType object |
|---|
Get aggregate-route-nexthop for route-aggregate.
| Returns: | xsd:string object |
|---|
Get annotations for route-aggregate.
| Returns: | KeyValuePairs object |
|---|
Get display-name for route-aggregate.
| Returns: | xsd:string object |
|---|
Display route-aggregate object in compact form.
Return FQN of route-aggregate in list form.
Return FQN of route-aggregate as colon delimited string.
Return FQN of route-aggregate’s parent in list form.
Return FQN of route-aggregate’s parent as colon delimted string.
Return routing-instance list for route-aggregate.
| Returns: | list of <RoutingInstance> |
|---|
Return service-instance list for route-aggregate.
| Returns: | list of tuple <ServiceInstance, ServiceInterfaceTag> |
|---|
Return tag list for route-aggregate.
| Returns: | list of <Tag> |
|---|
Return object type (route-aggregate).
Get id-perms for route-aggregate.
| Returns: | IdPermsType object |
|---|
Get perms2 for route-aggregate.
| Returns: | PermType2 object |
|---|
Set routing-instance for route-aggregate.
| Parameters: | ref_obj – RoutingInstance object |
|---|
Set routing-instance list for route-aggregate.
| Parameters: | ref_obj_list – list of RoutingInstance object |
|---|
Set service-instance for route-aggregate.
| Parameters: |
|
|---|
Set service-instance list for route-aggregate.
| Parameters: |
|
|---|
Set tag for route-aggregate.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for route-aggregate.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Network route table is mechanism of adding static routes in the virtual network
Type: RouteTableType
Created By: User (required)
Operations Allowed: CRUD
Description:
Routes in the route table are configured in following way.
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 route-table.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for route-table.
| Returns: | KeyValuePairs object |
|---|
Get display-name for route-table.
| Returns: | xsd:string object |
|---|
Display route-table object in compact form.
Return FQN of route-table in list form.
Return FQN of route-table as colon delimited string.
Return list of all logical-routers using this route-table
Return FQN of route-table’s parent in list form.
Return FQN of route-table’s parent as colon delimted string.
Return tag list for route-table.
| Returns: | list of <Tag> |
|---|
Return object type (route-table).
Return list of all virtual-networks using this route-table
Get id-perms for route-table.
| Returns: | IdPermsType object |
|---|
Get perms2 for route-table.
| Returns: | PermType2 object |
|---|
Get routes for route-table.
| Returns: | RouteTableType object |
|---|
Set tag for route-table.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for route-table.
| 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.
Children:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to route-target.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for route-target.
| Returns: | KeyValuePairs object |
|---|
Get display-name for route-target.
| Returns: | xsd:string object |
|---|
Display route-target object in compact form.
Return FQN of route-target in list form.
Return FQN of route-target as colon delimited string.
Return list of all logical-routers using this route-target
Return list of all routing-instances using this route-target
Return tag list for route-target.
| Returns: | list of <Tag> |
|---|
Return object type (route-target).
Get id-perms for route-target.
| Returns: | IdPermsType object |
|---|
Get perms2 for route-target.
| Returns: | PermType2 object |
|---|
Set tag for route-target.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for route-target.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
List of references of routing instances for this virtual network, routing instances are internal to the system.
Type: ServiceChainInfo
Created By: System
Operations Allowed: CRUD
Description:
Internal service chaining information, should not be modified.
Type: ServiceChainInfo
Created By: System
Operations Allowed: CRUD
Description:
Internal service chaining information, should not be modified.
Type: ServiceChainInfo
Created By: System
Operations Allowed: CRUD
Description:
Internal service chaining information, should not be modified.
Type: ServiceChainInfo
Created By: System
Operations Allowed: CRUD
Description:
Internal service chaining information, should not be modified.
Type: bool
Created By: System
Operations Allowed: CRUD
Description:
Internal service chaining information, should not be modified.
Type: bool
Created By: System
Operations Allowed: CRUD
Description:
Internal service chaining information, should not be modified.
Type: StaticRouteEntriesType
Created By: System
Operations Allowed: CRUD
Description:
Internal service chaining information, should not be modified.
Type: bool
Created By: System
Operations Allowed: CRUD
Description:
Provide connectivity to underlay network by port mapping trafficwith source IP of compute node
Type: DefaultProtocolType
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.
Created By: User (optionalCRUD)
Operations Allowed: BGP router object represent configuration of BGP peers. All the BGP peers involved in contrail system are under default routing instance of the default virtual network.
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
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 route-target to routing-instance.
| Parameters: |
|
|---|
Add routing-instance to routing-instance.
| Parameters: |
|
|---|
Add tag to routing-instance.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for routing-instance.
| Returns: | KeyValuePairs object |
|---|
Get default-ce-protocol for routing-instance.
| Returns: | DefaultProtocolType object |
|---|
Get display-name for routing-instance.
| Returns: | xsd:string object |
|---|
Display routing-instance object in compact form.
Get evpn-ipv6-service-chain-information for routing-instance.
| Returns: | ServiceChainInfo object |
|---|
Get evpn-service-chain-information for routing-instance.
| Returns: | ServiceChainInfo object |
|---|
Return FQN of routing-instance in list form.
Return FQN of routing-instance as colon delimited string.
Return FQN of routing-instance’s parent in list form.
Return FQN of routing-instance’s parent as colon delimted string.
Return list of all route-aggregates using this routing-instance
Return route-target list for routing-instance.
| Returns: | list of tuple <RouteTarget, InstanceTargetType> |
|---|
Return list of all routing-instances using this routing-instance
Return routing-instance list for routing-instance.
| Returns: | list of tuple <RoutingInstance, ConnectionType> |
|---|
Return list of all routing-policys using this routing-instance
Return tag list for routing-instance.
| Returns: | list of <Tag> |
|---|
Return object type (routing-instance).
Return list of all virtual-machine-interfaces using this routing-instance
Get id-perms for routing-instance.
| Returns: | IdPermsType object |
|---|
Get ipv6-service-chain-information for routing-instance.
| Returns: | ServiceChainInfo object |
|---|
Get perms2 for routing-instance.
| Returns: | PermType2 object |
|---|
Get routing-instance-fabric-snat for routing-instance.
| Returns: | xsd:boolean object |
|---|
Get routing-instance-has-pnf for routing-instance.
| Returns: | xsd:boolean object |
|---|
Get routing-instance-is-default for routing-instance.
| Returns: | xsd:boolean object |
|---|
Get service-chain-information for routing-instance.
| Returns: | ServiceChainInfo object |
|---|
Set route-target for routing-instance.
| Parameters: |
|
|---|
Set route-target list for routing-instance.
| Parameters: |
|
|---|
Set routing-instance for routing-instance.
| Parameters: |
|
|---|
Set routing-instance list for routing-instance.
| Parameters: |
|
|---|
Set tag for routing-instance.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for routing-instance.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get static-route-entries for routing-instance.
| Returns: | StaticRouteEntriesType object |
|---|
Bases: future.types.newobject.newobject
List of references of child routing policy objects. automatically maintained by system.
Type: PolicyStatementType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: str, one-of [u’vrouter’, u’network-device’]
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:
Reference to interface route table attached to routing policy.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to routing policy attached to (service instance, interface).
Created By: User (Reference to internal routing instance object automatically generated by system. Reference has property of sequence number which is order of in which routing policies are applied to given routing instance.)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add interface-route-table to routing-policy.
| Parameters: | ref_obj – InterfaceRouteTable object |
|---|
Add routing-instance to routing-policy.
| Parameters: |
|
|---|
Add service-instance to routing-policy.
| Parameters: |
|
|---|
Add tag to routing-policy.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for routing-policy.
| Returns: | KeyValuePairs object |
|---|
Get display-name for routing-policy.
| Returns: | xsd:string object |
|---|
Display routing-policy object in compact form.
Return list of all data-center-interconnects using this routing-policy
Return FQN of routing-policy in list form.
Return FQN of routing-policy as colon delimited string.
Return interface-route-table list for routing-policy.
| Returns: | list of <InterfaceRouteTable> |
|---|
Return FQN of routing-policy’s parent in list form.
Return FQN of routing-policy’s parent as colon delimted string.
Return routing-instance list for routing-policy.
| Returns: | list of tuple <RoutingInstance, RoutingPolicyType> |
|---|
Return service-instance list for routing-policy.
| Returns: | list of tuple <ServiceInstance, RoutingPolicyServiceInstanceType> |
|---|
Return tag list for routing-policy.
| Returns: | list of <Tag> |
|---|
Return object type (routing-policy).
Return list of all virtual-networks using this routing-policy
Get id-perms for routing-policy.
| Returns: | IdPermsType object |
|---|
Get perms2 for routing-policy.
| Returns: | PermType2 object |
|---|
Get routing-policy-entries for routing-policy.
| Returns: | PolicyStatementType object |
|---|
Set interface-route-table for routing-policy.
| Parameters: | ref_obj – InterfaceRouteTable object |
|---|
Set interface-route-table list for routing-policy.
| Parameters: | ref_obj_list – list of InterfaceRouteTable object |
|---|
Set routing-instance for routing-policy.
| Parameters: |
|
|---|
Set routing-instance list for routing-policy.
| Parameters: |
|
|---|
Set service-instance for routing-policy.
| Parameters: |
|
|---|
Set service-instance list for routing-policy.
| Parameters: |
|
|---|
Set tag for routing-policy.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for routing-policy.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get term-type for routing-policy.
| Returns: | TermType object |
|---|
Bases: future.types.newobject.newobject
Security Groups are set of state full access control rules attached to interfaces.It can be used to implement microsegmentation.
Type: int, within [8000000, 4294967296]
Created By: System
Operations Allowed: R
Description:
Unique 32 bit ID automatically assigned to this security group [8M+1, 32G].
Type: int, within [0, 7999999]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Unique 32 bit user defined ID assigned to this security group [1, 8M - 1].
Type: PolicyEntriesType
Created By: User (required)
Operations Allowed: CRUD
Description:
Security group rule entries.
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:
port access control list is automatically derived from all the security groups attached to port.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to security-group.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for security-group.
| Returns: | KeyValuePairs object |
|---|
Get configured-security-group-id for security-group.
| Returns: | ConfiguredSecurityGroupIdType object |
|---|
Get display-name for security-group.
| Returns: | xsd:string object |
|---|
Display security-group object in compact form.
Return FQN of security-group in list form.
Return FQN of security-group as colon delimited string.
Return FQN of security-group’s parent in list form.
Return FQN of security-group’s parent as colon delimted string.
Return list of all security-logging-objects using this security-group
Return tag list for security-group.
| Returns: | list of <Tag> |
|---|
Return object type (security-group).
Return list of all virtual-machine-interfaces using this security-group
Return list of all virtual-port-groups using this security-group
Get id-perms for security-group.
| Returns: | IdPermsType object |
|---|
Get perms2 for security-group.
| Returns: | PermType2 object |
|---|
Get security-group-entries for security-group.
| Returns: | PolicyEntriesType object |
|---|
Get security-group-id for security-group.
| Returns: | SecurityGroupIdType object |
|---|
Set tag for security-group.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for security-group.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Type: SecurityLoggingObjectRuleListType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Security logging object rules derived internally.
Type: int
Created By: User (optional)
Operations Allowed: CRUD
Description:
Security logging object rate defining rate of session logging
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 network-policy attached to this security-logging-object
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to security-group attached to this security-logging-object
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add network-policy to security-logging-object.
| Parameters: |
|
|---|
Add security-group to security-logging-object.
| Parameters: |
|
|---|
Add tag to security-logging-object.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for security-logging-object.
| Returns: | KeyValuePairs object |
|---|
Get display-name for security-logging-object.
| Returns: | xsd:string object |
|---|
Display security-logging-object object in compact form.
Return list of all firewall-policys using this security-logging-object
Return list of all firewall-rules using this security-logging-object
Return FQN of security-logging-object in list form.
Return FQN of security-logging-object as colon delimited string.
Return network-policy list for security-logging-object.
| Returns: | list of tuple <NetworkPolicy, SecurityLoggingObjectRuleListType> |
|---|
Return FQN of security-logging-object’s parent in list form.
Return FQN of security-logging-object’s parent as colon delimted string.
Return security-group list for security-logging-object.
| Returns: | list of tuple <SecurityGroup, SecurityLoggingObjectRuleListType> |
|---|
Return tag list for security-logging-object.
| Returns: | list of <Tag> |
|---|
Return object type (security-logging-object).
Return list of all virtual-machine-interfaces using this security-logging-object
Return list of all virtual-networks using this security-logging-object
Get id-perms for security-logging-object.
| Returns: | IdPermsType object |
|---|
Get perms2 for security-logging-object.
| Returns: | PermType2 object |
|---|
Get security-logging-object-rate for security-logging-object.
| Returns: | xsd:integer object |
|---|
Get security-logging-object-rules for security-logging-object.
| Returns: | SecurityLoggingObjectRuleListType object |
|---|
Set network-policy for security-logging-object.
| Parameters: |
|
|---|
Set network-policy list for security-logging-object.
| Parameters: |
|
|---|
Set security-group for security-logging-object.
| Parameters: |
|
|---|
Set security-group list for security-logging-object.
| Parameters: |
|
|---|
Set tag for security-logging-object.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for security-logging-object.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Service appliance is a member in service appliance set (e.g. Loadbalancer, Firewall provider).By default system will create “ha-proxy” based service appliance.
Type: UserCredentials
Created By: User (optional)
Operations Allowed: CRUD
Description:
Authentication credentials for driver to access service appliance.
Type: str, one-of xsd:string
Created By: User (required)
Operations Allowed: CRUD
Description:
Management Ip address of the service-appliance.
Type: str, one-of [u’virtual-machine’, u’network-namespace’, u’vrouter-instance’, u’physical-device’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Service virtualization type decides how individual service instances are instantiated
Type: KeyValuePairs
Created By: User (required)
Operations Allowed: CRUD
Description:
List of Key:Value pairs used by the provider driver of this service appliance.
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 physical interface that can be used as (service interface type)left, right, management
OR other.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add physical-interface to service-appliance.
| Parameters: |
|
|---|
Add tag to service-appliance.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for service-appliance.
| Returns: | KeyValuePairs object |
|---|
Get display-name for service-appliance.
| Returns: | xsd:string object |
|---|
Display service-appliance object in compact form.
Return FQN of service-appliance in list form.
Return FQN of service-appliance as colon delimited string.
Return FQN of service-appliance’s parent in list form.
Return FQN of service-appliance’s parent as colon delimted string.
Return physical-interface list for service-appliance.
| Returns: | list of tuple <PhysicalInterface, ServiceApplianceInterfaceType> |
|---|
Return tag list for service-appliance.
| Returns: | list of <Tag> |
|---|
Return object type (service-appliance).
Get id-perms for service-appliance.
| Returns: | IdPermsType object |
|---|
Get perms2 for service-appliance.
| Returns: | PermType2 object |
|---|
Get service-appliance-ip-address for service-appliance.
| Returns: | IpAddressType object |
|---|
Get service-appliance-properties for service-appliance.
| Returns: | KeyValuePairs object |
|---|
Get service-appliance-user-credentials for service-appliance.
| Returns: | UserCredentials object |
|---|
Get service-appliance-virtualization-type for service-appliance.
| Returns: | ServiceVirtualizationType object |
|---|
Set physical-interface for service-appliance.
| Parameters: |
|
|---|
Set physical-interface list for service-appliance.
| Parameters: |
|
|---|
Set tag for service-appliance.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for service-appliance.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Service appliance set is the collection of service appliances. This collection is used as a provider in loadbalancer pool config. Algorithm to distribute/choose one appliance over other can be built while creating loadbalancer pool. By default, system will create service-appliance-set with name “opencontrail”. This is the default loadbalancer provider for pools in Contrail. This provider is based on “ha-proxy”.Service appliance set has following attribute -
Driver to load for provisioning the appliance Service appliance properties - HA mode.
Type: str, one-of [u’virtual-machine’, u’network-namespace’, u’vrouter-instance’, u’physical-device’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Service virtualization type decides how individual service instances are instantiated
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of Key:Value pairs that are used by the provider driver and opaque to system.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Name of the provider driver for this service appliance set.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
High availability mode for the service appliance set, active-active or active-backup.
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:
Service appliance is a member in service appliance set (e.g. Loadbalancer, Firewall provider).By
default system will create “ha-proxy” based service appliance.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to service-appliance-set.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for service-appliance-set.
| Returns: | KeyValuePairs object |
|---|
Get display-name for service-appliance-set.
| Returns: | xsd:string object |
|---|
Display service-appliance-set object in compact form.
Return FQN of service-appliance-set in list form.
Return FQN of service-appliance-set as colon delimited string.
Return list of all loadbalancers using this service-appliance-set
Return list of all loadbalancer-pools using this service-appliance-set
Return FQN of service-appliance-set’s parent in list form.
Return FQN of service-appliance-set’s parent as colon delimted string.
Return list of all service-templates using this service-appliance-set
Return tag list for service-appliance-set.
| Returns: | list of <Tag> |
|---|
Return object type (service-appliance-set).
Get id-perms for service-appliance-set.
| Returns: | IdPermsType object |
|---|
Get perms2 for service-appliance-set.
| Returns: | PermType2 object |
|---|
Get service-appliance-driver for service-appliance-set.
| Returns: | xsd:string object |
|---|
Get service-appliance-ha-mode for service-appliance-set.
| Returns: | xsd:string object |
|---|
Get service-appliance-set-properties for service-appliance-set.
| Returns: | KeyValuePairs object |
|---|
Get service-appliance-set-virtualization-type for service-appliance-set.
| Returns: | ServiceVirtualizationType object |
|---|
Set tag for service-appliance-set.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for service-appliance-set.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Created By:
Type: str, one-of [u’point-to-point’, u’point-to-list’, u’multi-point-to-multi-point’]
Created By: User (required)
Operations Allowed: CRUD
Description:
E2 service type.
Type: str, one-of [u’vpws-l2ckt’, u’vpws-l2vpn’, u’vpws-evpn’, u’fabric-interface’]
Created By: User (required)
Operations Allowed: CRUD
Description:
Type of service assigned for this object
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-connection-module to a service object.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add service-object to service-connection-module.
| Parameters: | ref_obj – ServiceObject object |
|---|
Add tag to service-connection-module.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for service-connection-module.
| Returns: | KeyValuePairs object |
|---|
Get display-name for service-connection-module.
| Returns: | xsd:string object |
|---|
Display service-connection-module object in compact form.
Get e2-service for service-connection-module.
| Returns: | E2servicetype object |
|---|
Return FQN of service-connection-module in list form.
Return FQN of service-connection-module as colon delimited string.
Return list of all service-endpoints using this service-connection-module
Return service-object list for service-connection-module.
| Returns: | list of <ServiceObject> |
|---|
Return tag list for service-connection-module.
| Returns: | list of <Tag> |
|---|
Return object type (service-connection-module).
Get id-perms for service-connection-module.
| Returns: | IdPermsType object |
|---|
Get perms2 for service-connection-module.
| Returns: | PermType2 object |
|---|
Get service-type for service-connection-module.
| Returns: | ServiceConnectionType object |
|---|
Set service-object for service-connection-module.
| Parameters: | ref_obj – ServiceObject object |
|---|
Set service-object list for service-connection-module.
| Parameters: | ref_obj_list – list of ServiceObject object |
|---|
Set tag for service-connection-module.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for service-connection-module.
| 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.
Children:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Link the service endpoint to service connection node
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to Router for a given service.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Links the service-endpoints to a service object.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add physical-router to service-endpoint.
| Parameters: | ref_obj – PhysicalRouter object |
|---|
Add service-connection-module to service-endpoint.
| Parameters: | ref_obj – ServiceConnectionModule object |
|---|
Add service-object to service-endpoint.
| Parameters: | ref_obj – ServiceObject object |
|---|
Add tag to service-endpoint.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for service-endpoint.
| Returns: | KeyValuePairs object |
|---|
Get display-name for service-endpoint.
| Returns: | xsd:string object |
|---|
Display service-endpoint object in compact form.
Return FQN of service-endpoint in list form.
Return FQN of service-endpoint as colon delimited string.
Return physical-router list for service-endpoint.
| Returns: | list of <PhysicalRouter> |
|---|
Return service-connection-module list for service-endpoint.
| Returns: | list of <ServiceConnectionModule> |
|---|
Return service-object list for service-endpoint.
| Returns: | list of <ServiceObject> |
|---|
Return tag list for service-endpoint.
| Returns: | list of <Tag> |
|---|
Return object type (service-endpoint).
Return list of all virtual-machine-interfaces using this service-endpoint
Get id-perms for service-endpoint.
| Returns: | IdPermsType object |
|---|
Get perms2 for service-endpoint.
| Returns: | PermType2 object |
|---|
Set physical-router for service-endpoint.
| Parameters: | ref_obj – PhysicalRouter object |
|---|
Set physical-router list for service-endpoint.
| Parameters: | ref_obj_list – list of PhysicalRouter object |
|---|
Set service-connection-module for service-endpoint.
| Parameters: | ref_obj – ServiceConnectionModule object |
|---|
Set service-connection-module list for service-endpoint.
| Parameters: | ref_obj_list – list of ServiceConnectionModule object |
|---|
Set service-object for service-endpoint.
| Parameters: | ref_obj – ServiceObject object |
|---|
Set service-object list for service-endpoint.
| Parameters: | ref_obj_list – list of ServiceObject object |
|---|
Set tag for service-endpoint.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for service-endpoint.
| 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: FirewallServiceGroupType
Created By: User (required)
Operations Allowed: CRUD
Description:
list of service objects (protocol, source port and destination port
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 service-group.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for service-group.
| Returns: | KeyValuePairs object |
|---|
Get display-name for service-group.
| Returns: | xsd:string object |
|---|
Get draft-mode-state for service-group.
| Returns: | DraftModeState object |
|---|
Display service-group object in compact form.
Return list of all firewall-rules using this service-group
Return FQN of service-group in list form.
Return FQN of service-group as colon delimited string.
Return FQN of service-group’s parent in list form.
Return FQN of service-group’s parent as colon delimted string.
Return tag list for service-group.
| Returns: | list of <Tag> |
|---|
Return object type (service-group).
Get id-perms for service-group.
| Returns: | IdPermsType object |
|---|
Get perms2 for service-group.
| Returns: | PermType2 object |
|---|
Get service-group-firewall-service-list for service-group.
| Returns: | FirewallServiceGroupType object |
|---|
Set tag for service-group.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for service-group.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Service health check is a keepalive mechanism for the virtual machine interface. Liveliness of the interface is determined based on configuration in the service health check. It is mainly designed for service instance interfaces. However it will work with any interface which present on contrail vrouter.
Type: ServiceHealthCheckType
Created By: User (required)
Operations Allowed: CRUD
Description:
Service health check has following fields.
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 instance using this service health check.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add service-instance to service-health-check.
| Parameters: |
|
|---|
Add tag to service-health-check.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for service-health-check.
| Returns: | KeyValuePairs object |
|---|
Get display-name for service-health-check.
| Returns: | xsd:string object |
|---|
Display service-health-check object in compact form.
Return list of all bgp-as-a-services using this service-health-check
Return FQN of service-health-check in list form.
Return FQN of service-health-check as colon delimited string.
Return FQN of service-health-check’s parent in list form.
Return FQN of service-health-check’s parent as colon delimted string.
Return service-instance list for service-health-check.
| Returns: | list of tuple <ServiceInstance, ServiceInterfaceTag> |
|---|
Return tag list for service-health-check.
| Returns: | list of <Tag> |
|---|
Return object type (service-health-check).
Return list of all virtual-machine-interfaces using this service-health-check
Return list of all virtual-networks using this service-health-check
Get id-perms for service-health-check.
| Returns: | IdPermsType object |
|---|
Get perms2 for service-health-check.
| Returns: | PermType2 object |
|---|
Get service-health-check-properties for service-health-check.
| Returns: | ServiceHealthCheckType object |
|---|
Set service-instance for service-health-check.
| Parameters: |
|
|---|
Set service-instance list for service-health-check.
| Parameters: |
|
|---|
Set tag for service-health-check.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for service-health-check.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Service instance represents logical instance service used in the virtual world, e.g. firewall, load balancer etc. It can represent one or multiple virtual machines or physical devices. Many service instances can share a virtual machine or physical device.
Type: ServiceInstanceType
Created By: User (required)
Operations Allowed: CRUD
Description:
Service instance configuration parameters.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Opaque key value pair for generating config for the service instance.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Enable BGP routing for this service instance
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:
Port tuples are ordered set of interfaces that represent a service virtual machine or physical
device , which is part of this service instance.
Order of interfaces in port tuple is same as specified in the service template.
example SI = [(Left, Right, Management), (L, R, M), ..., (L, R, M)].
Created By: User (required)
Operations Allowed: CRUD
Description:
Reference to the service template of this service instance.
Created By: System
Operations Allowed: CRUD
Description:
Reference to ip address, which is used as nexthop pointing to (service instance, service interface).
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add instance-ip to service-instance.
| Parameters: |
|
|---|
Add service-template to service-instance.
| Parameters: | ref_obj – ServiceTemplate object |
|---|
Add tag to service-instance.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for service-instance.
| Returns: | KeyValuePairs object |
|---|
Get display-name for service-instance.
| Returns: | xsd:string object |
|---|
Display service-instance object in compact form.
Return FQN of service-instance in list form.
Return FQN of service-instance as colon delimited string.
Return instance-ip list for service-instance.
| Returns: | list of tuple <InstanceIp, ServiceInterfaceTag> |
|---|
Return list of all interface-route-tables using this service-instance
Return list of all loadbalancers using this service-instance
Return list of all loadbalancer-pools using this service-instance
Return list of all logical-routers using this service-instance
Return FQN of service-instance’s parent in list form.
Return FQN of service-instance’s parent as colon delimted string.
Return list of all route-aggregates using this service-instance
Return list of all routing-policys using this service-instance
Return list of all service-health-checks using this service-instance
Return service-template list for service-instance.
| Returns: | list of <ServiceTemplate> |
|---|
Return tag list for service-instance.
| Returns: | list of <Tag> |
|---|
Return object type (service-instance).
Return list of all virtual-machines using this service-instance
Get id-perms for service-instance.
| Returns: | IdPermsType object |
|---|
Get perms2 for service-instance.
| Returns: | PermType2 object |
|---|
Get service-instance-bgp-enabled for service-instance.
| Returns: | xsd:boolean object |
|---|
Get service-instance-bindings for service-instance.
| Returns: | KeyValuePairs object |
|---|
Get service-instance-properties for service-instance.
| Returns: | ServiceInstanceType object |
|---|
Set instance-ip for service-instance.
| Parameters: |
|
|---|
Set instance-ip list for service-instance.
| Parameters: |
|
|---|
Set service-template for service-instance.
| Parameters: | ref_obj – ServiceTemplate object |
|---|
Set service-template list for service-instance.
| Parameters: | ref_obj_list – list of ServiceTemplate object |
|---|
Set tag for service-instance.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for service-instance.
| 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.
Children:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to service-object.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for service-object.
| Returns: | KeyValuePairs object |
|---|
Get display-name for service-object.
| Returns: | xsd:string object |
|---|
Display service-object object in compact form.
Return FQN of service-object in list form.
Return FQN of service-object as colon delimited string.
Return list of all service-connection-modules using this service-object
Return list of all service-endpoints using this service-object
Return tag list for service-object.
| Returns: | list of <Tag> |
|---|
Return object type (service-object).
Get id-perms for service-object.
| Returns: | IdPermsType object |
|---|
Get perms2 for service-object.
| Returns: | PermType2 object |
|---|
Set tag for service-object.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for service-object.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Service template defines how a service may be deployed in the network. Service instance is instantiated from config in service template.
Type: ServiceTemplateType
Created By: User (required)
Operations Allowed: CRUD
Description:
Service template configuration parameters.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Enable whether service config for PNFs needs to be managed by Contrail
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 the service appliance set represented by this service template.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add service-appliance-set to service-template.
| Parameters: | ref_obj – ServiceApplianceSet object |
|---|
Add tag to service-template.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for service-template.
| Returns: | KeyValuePairs object |
|---|
Get display-name for service-template.
| Returns: | xsd:string object |
|---|
Display service-template object in compact form.
Return FQN of service-template in list form.
Return FQN of service-template as colon delimited string.
Return FQN of service-template’s parent in list form.
Return FQN of service-template’s parent as colon delimted string.
Return service-appliance-set list for service-template.
| Returns: | list of <ServiceApplianceSet> |
|---|
Return list of all service-instances using this service-template
Return tag list for service-template.
| Returns: | list of <Tag> |
|---|
Return object type (service-template).
Get id-perms for service-template.
| Returns: | IdPermsType object |
|---|
Get perms2 for service-template.
| Returns: | PermType2 object |
|---|
Get service-config-managed for service-template.
| Returns: | xsd:boolean object |
|---|
Get service-template-properties for service-template.
| Returns: | ServiceTemplateType object |
|---|
Set service-appliance-set for service-template.
| Parameters: | ref_obj – ServiceApplianceSet object |
|---|
Set service-appliance-set list for service-template.
| Parameters: | ref_obj_list – list of ServiceApplianceSet object |
|---|
Set tag for service-template.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for service-template.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
This resource contains information specific to sflow parameters
- Created By:
- User
- Child of:
- Project object
- Properties:
- sflow_profile_is_default
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
This attribute indicates whether it is a default sflow profile or not. Default profiles are non-
editable.
- sflow_parameters
Type: SflowParameters
Created By: User (optional)
Operations Allowed: CRUD
Description:
Parameters for each sflow profile, such as polling interval, sample rate, list of sflow enabled
interfaces, sflow agent ID etc.
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
- Referred by:
- list of TelemetryProfile objects
Add tag to sflow-profile.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for sflow-profile.
| Returns: | KeyValuePairs object |
|---|
Get display-name for sflow-profile.
| Returns: | xsd:string object |
|---|
Display sflow-profile object in compact form.
Return FQN of sflow-profile in list form.
Return FQN of sflow-profile as colon delimited string.
Return FQN of sflow-profile’s parent in list form.
Return FQN of sflow-profile’s parent as colon delimted string.
Return tag list for sflow-profile.
| Returns: | list of <Tag> |
|---|
Return list of all telemetry-profiles using this sflow-profile
Return object type (sflow-profile).
Get id-perms for sflow-profile.
| Returns: | IdPermsType object |
|---|
Get perms2 for sflow-profile.
| Returns: | PermType2 object |
|---|
Set tag for sflow-profile.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for sflow-profile.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get sflow-parameters for sflow-profile.
| Returns: | SflowParameters object |
|---|
Get sflow-profile-is-default for sflow-profile.
| Returns: | xsd:boolean object |
|---|
Bases: future.types.newobject.newobject
This resource contains information specific to snmp parameters
- Created By:
- User
- Child of:
- Project object
- Properties:
- snmp_profile_is_default
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
This attribute indicates whether it is a default snmp profile or not. Default profiles are non-
editable.
- snmp_parameters
Type: SnmpParameters
Created By: User (optional)
Operations Allowed: CRUD
Description:
Parameters for each snmp profile like the top level sensor options etc.
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
- Referred by:
- list of TelemetryProfile objects
Add tag to snmp-profile.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for snmp-profile.
| Returns: | KeyValuePairs object |
|---|
Get display-name for snmp-profile.
| Returns: | xsd:string object |
|---|
Display snmp-profile object in compact form.
Return FQN of snmp-profile in list form.
Return FQN of snmp-profile as colon delimited string.
Return FQN of snmp-profile’s parent in list form.
Return FQN of snmp-profile’s parent as colon delimted string.
Return tag list for snmp-profile.
| Returns: | list of <Tag> |
|---|
Return list of all telemetry-profiles using this snmp-profile
Return object type (snmp-profile).
Get id-perms for snmp-profile.
| Returns: | IdPermsType object |
|---|
Get perms2 for snmp-profile.
| Returns: | PermType2 object |
|---|
Set tag for snmp-profile.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for snmp-profile.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get snmp-parameters for snmp-profile.
| Returns: | SnmpParameters object |
|---|
Get snmp-profile-is-default for snmp-profile.
| Returns: | xsd:boolean object |
|---|
Bases: future.types.newobject.newobject
Storm control profile definition
- Created By:
- User
- Child of:
- Project object
- Properties:
- storm_control_parameters
Type: StormControlParameters
Created By: User (optional)
Operations Allowed: CRUD
Description:
Parameters for the storm control profile, such as bandwidth percentage, actions, traffic type,
receovery timeout etc.
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
- Referred by:
- list of PortProfile objects
Add tag to storm-control-profile.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for storm-control-profile.
| Returns: | KeyValuePairs object |
|---|
Get display-name for storm-control-profile.
| Returns: | xsd:string object |
|---|
Display storm-control-profile object in compact form.
Return FQN of storm-control-profile in list form.
Return FQN of storm-control-profile as colon delimited string.
Return FQN of storm-control-profile’s parent in list form.
Return FQN of storm-control-profile’s parent as colon delimted string.
Return list of all port-profiles using this storm-control-profile
Return tag list for storm-control-profile.
| Returns: | list of <Tag> |
|---|
Return object type (storm-control-profile).
Get id-perms for storm-control-profile.
| Returns: | IdPermsType object |
|---|
Get perms2 for storm-control-profile.
| Returns: | PermType2 object |
|---|
Set tag for storm-control-profile.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for storm-control-profile.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get storm-control-parameters for storm-control-profile.
| Returns: | StormControlParameters object |
|---|
Bases: future.types.newobject.newobject
mapping App name to other entities
- Created By:
- User
- Child of:
- StructuredSyslogConfig object
- Properties:
- structured_syslog_app_category
Type: str
Created By: User (required)
Operations Allowed: CRUD
Description:
The application category
- structured_syslog_app_subcategory
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
The application sub category
- structured_syslog_app_groups
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
app groups comma separated
- structured_syslog_app_risk
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
The application risk profile
- structured_syslog_app_service_tags
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
service-tags corresponding to applications
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to structured-syslog-application-record.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for structured-syslog-application-record.
| Returns: | KeyValuePairs object |
|---|
Get display-name for structured-syslog-application-record.
| Returns: | xsd:string object |
|---|
Display structured-syslog-application-record object in compact form.
Return FQN of structured-syslog-application-record in list form.
Return FQN of structured-syslog-application-record as colon delimited string.
Return FQN of structured-syslog-application-record’s parent in list form.
Return FQN of structured-syslog-application-record’s parent as colon delimted string.
Return tag list for structured-syslog-application-record.
| Returns: | list of <Tag> |
|---|
Return object type (structured-syslog-application-record).
Get id-perms for structured-syslog-application-record.
| Returns: | IdPermsType object |
|---|
Get perms2 for structured-syslog-application-record.
| Returns: | PermType2 object |
|---|
Set tag for structured-syslog-application-record.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for structured-syslog-application-record.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get structured-syslog-app-category for structured-syslog-application-record.
| Returns: | xsd:string object |
|---|
Get structured-syslog-app-groups for structured-syslog-application-record.
| Returns: | xsd:string object |
|---|
Get structured-syslog-app-risk for structured-syslog-application-record.
| Returns: | xsd:string object |
|---|
Get structured-syslog-app-service-tags for structured-syslog-application-record.
| Returns: | xsd:string object |
|---|
Get structured-syslog-app-subcategory for structured-syslog-application-record.
| Returns: | xsd:string object |
|---|
Bases: future.types.newobject.newobject
structured syslog config related data
- Created By:
- User when parent is GlobalAnalyticsConfig User when parent is Project
- Child of:
- GlobalAnalyticsConfig object OR Project object
- Properties:
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
- Children:
- list of StructuredSyslogMessage objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of structured-syslog-message that are applicable to objects anchored under
structured-syslog-config.
- list of StructuredSyslogHostnameRecord objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of structured-syslog-hostname-record that are applicable to objects anchored
under structured-syslog-config.
- list of StructuredSyslogTenantRecord objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of structured-syslog-tenant-record that are applicable to objects anchored
under structured-syslog-config.
- list of StructuredSyslogApplicationRecord objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of structured-syslog-application-record that are applicable to objects anchored
under structured-syslog-config.
- list of StructuredSyslogSlaProfile objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of structured-syslog-sla-profile that are applicable to objects anchored under
structured-syslog-config.
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to structured-syslog-config.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for structured-syslog-config.
| Returns: | KeyValuePairs object |
|---|
Get display-name for structured-syslog-config.
| Returns: | xsd:string object |
|---|
Display structured-syslog-config object in compact form.
Return FQN of structured-syslog-config in list form.
Return FQN of structured-syslog-config as colon delimited string.
Return FQN of structured-syslog-config’s parent in list form.
Return FQN of structured-syslog-config’s parent as colon delimted string.
Return tag list for structured-syslog-config.
| Returns: | list of <Tag> |
|---|
Return object type (structured-syslog-config).
Get id-perms for structured-syslog-config.
| Returns: | IdPermsType object |
|---|
Get perms2 for structured-syslog-config.
| Returns: | PermType2 object |
|---|
Set tag for structured-syslog-config.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for structured-syslog-config.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
mapping Hostname to other entities
- Created By:
- User
- Child of:
- StructuredSyslogConfig object
- Properties:
- structured_syslog_hostaddr
Type: str
Created By: User (required)
Operations Allowed: CRUD
Description:
The host address
- structured_syslog_tenant
Type: str
Created By: User (required)
Operations Allowed: CRUD
Description:
The tenant name
- structured_syslog_location
Type: str
Created By: User (required)
Operations Allowed: CRUD
Description:
location details
- structured_syslog_device
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
device id
- structured_syslog_hostname_tags
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
tags corresponding to the host
- structured_syslog_linkmap
Type: StructuredSyslogLinkmap
Created By: User (optional)
Operations Allowed: CRUD
Description:
overlay to underlay mapping
- structured_syslog_lan_segment_list
Type: StructuredSyslogLANSegmentList
Created By: User (optional)
Operations Allowed: CRUD
Description:
vpn to network-ranges mapping
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to structured-syslog-hostname-record.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for structured-syslog-hostname-record.
| Returns: | KeyValuePairs object |
|---|
Get display-name for structured-syslog-hostname-record.
| Returns: | xsd:string object |
|---|
Display structured-syslog-hostname-record object in compact form.
Return FQN of structured-syslog-hostname-record in list form.
Return FQN of structured-syslog-hostname-record as colon delimited string.
Return FQN of structured-syslog-hostname-record’s parent in list form.
Return FQN of structured-syslog-hostname-record’s parent as colon delimted string.
Return tag list for structured-syslog-hostname-record.
| Returns: | list of <Tag> |
|---|
Return object type (structured-syslog-hostname-record).
Get id-perms for structured-syslog-hostname-record.
| Returns: | IdPermsType object |
|---|
Get perms2 for structured-syslog-hostname-record.
| Returns: | PermType2 object |
|---|
Set tag for structured-syslog-hostname-record.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for structured-syslog-hostname-record.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get structured-syslog-device for structured-syslog-hostname-record.
| Returns: | xsd:string object |
|---|
Get structured-syslog-hostaddr for structured-syslog-hostname-record.
| Returns: | xsd:string object |
|---|
Get structured-syslog-hostname-tags for structured-syslog-hostname-record.
| Returns: | xsd:string object |
|---|
Get structured-syslog-lan-segment-list for structured-syslog-hostname-record.
| Returns: | StructuredSyslogLANSegmentList object |
|---|
Get structured-syslog-linkmap for structured-syslog-hostname-record.
| Returns: | StructuredSyslogLinkmap object |
|---|
Get structured-syslog-location for structured-syslog-hostname-record.
| Returns: | xsd:string object |
|---|
Get structured-syslog-tenant for structured-syslog-hostname-record.
| Returns: | xsd:string object |
|---|
Bases: future.types.newobject.newobject
structured syslog messages to be handled
- Created By:
- User
- Child of:
- StructuredSyslogConfig object
- Properties:
- structured_syslog_message_tagged_fields
Type: FieldNamesList
Created By: User (required)
Operations Allowed: CRUD
Description:
list of field names in the message to be tagged
- structured_syslog_message_integer_fields
Type: FieldNamesList
Created By: User (required)
Operations Allowed: CRUD
Description:
list of integer fields in the message
- structured_syslog_message_process_and_store
Type: bool
Created By: User (required)
Operations Allowed: CRUD
Description:
message is to be processed and stored or not
- structured_syslog_message_process_and_summarize
Type: bool
Created By: User (required)
Operations Allowed: CRUD
Description:
message is to be processed and summarized or not
- structured_syslog_message_process_and_summarize_user
Type: bool
Created By: User (required)
Operations Allowed: CRUD
Description:
message is to be processed and summarized for user or not
- structured_syslog_message_forward
Type: str, one-of [u’do-not-forward’, u’forward-unprocessed’, u’forward-processed’]
Created By: User (required)
Operations Allowed: CRUD
Description:
fowarding action to be taken on the message
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to structured-syslog-message.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for structured-syslog-message.
| Returns: | KeyValuePairs object |
|---|
Get display-name for structured-syslog-message.
| Returns: | xsd:string object |
|---|
Display structured-syslog-message object in compact form.
Return FQN of structured-syslog-message in list form.
Return FQN of structured-syslog-message as colon delimited string.
Return FQN of structured-syslog-message’s parent in list form.
Return FQN of structured-syslog-message’s parent as colon delimted string.
Return tag list for structured-syslog-message.
| Returns: | list of <Tag> |
|---|
Return object type (structured-syslog-message).
Get id-perms for structured-syslog-message.
| Returns: | IdPermsType object |
|---|
Get perms2 for structured-syslog-message.
| Returns: | PermType2 object |
|---|
Set tag for structured-syslog-message.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for structured-syslog-message.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get structured-syslog-message-forward for structured-syslog-message.
| Returns: | StructuredSyslogMessageForwardType object |
|---|
Get structured-syslog-message-integer-fields for structured-syslog-message.
| Returns: | FieldNamesList object |
|---|
Get structured-syslog-message-process-and-store for structured-syslog-message.
| Returns: | xsd:boolean object |
|---|
Get structured-syslog-message-process-and-summarize for structured-syslog-message.
| Returns: | xsd:boolean object |
|---|
Get structured-syslog-message-process-and-summarize-user for structured-syslog-message.
| Returns: | xsd:boolean object |
|---|
Get structured-syslog-message-tagged-fields for structured-syslog-message.
| Returns: | FieldNamesList object |
|---|
Bases: future.types.newobject.newobject
mapping sla-profile to sla params
- Created By:
- User
- Child of:
- StructuredSyslogConfig object
- Properties:
- structured_syslog_sla_params
Type: str
Created By: User (required)
Operations Allowed: CRUD
Description:
The sla params like sampling %age and
traffic type
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to structured-syslog-sla-profile.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for structured-syslog-sla-profile.
| Returns: | KeyValuePairs object |
|---|
Get display-name for structured-syslog-sla-profile.
| Returns: | xsd:string object |
|---|
Display structured-syslog-sla-profile object in compact form.
Return FQN of structured-syslog-sla-profile in list form.
Return FQN of structured-syslog-sla-profile as colon delimited string.
Return FQN of structured-syslog-sla-profile’s parent in list form.
Return FQN of structured-syslog-sla-profile’s parent as colon delimted string.
Return tag list for structured-syslog-sla-profile.
| Returns: | list of <Tag> |
|---|
Return object type (structured-syslog-sla-profile).
Get id-perms for structured-syslog-sla-profile.
| Returns: | IdPermsType object |
|---|
Get perms2 for structured-syslog-sla-profile.
| Returns: | PermType2 object |
|---|
Set tag for structured-syslog-sla-profile.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for structured-syslog-sla-profile.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get structured-syslog-sla-params for structured-syslog-sla-profile.
| Returns: | xsd:string object |
|---|
Bases: future.types.newobject.newobject
mapping Tenant to other entities
- Created By:
- User
- Child of:
- StructuredSyslogConfig object
- Properties:
- structured_syslog_tenant
Type: str
Created By: User (required)
Operations Allowed: CRUD
Description:
The tenant name
- structured_syslog_tenantaddr
Type: str
Created By: User (required)
Operations Allowed: CRUD
Description:
The tenant address
- structured_syslog_tenant_tags
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
tags corresponding to the tenant
- structured_syslog_dscpmap
Type: StructuredSyslogDSCPMap
Created By: User (optional)
Operations Allowed: CRUD
Description:
dscp to Alias mapping
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to structured-syslog-tenant-record.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for structured-syslog-tenant-record.
| Returns: | KeyValuePairs object |
|---|
Get display-name for structured-syslog-tenant-record.
| Returns: | xsd:string object |
|---|
Display structured-syslog-tenant-record object in compact form.
Return FQN of structured-syslog-tenant-record in list form.
Return FQN of structured-syslog-tenant-record as colon delimited string.
Return FQN of structured-syslog-tenant-record’s parent in list form.
Return FQN of structured-syslog-tenant-record’s parent as colon delimted string.
Return tag list for structured-syslog-tenant-record.
| Returns: | list of <Tag> |
|---|
Return object type (structured-syslog-tenant-record).
Get id-perms for structured-syslog-tenant-record.
| Returns: | IdPermsType object |
|---|
Get perms2 for structured-syslog-tenant-record.
| Returns: | PermType2 object |
|---|
Set tag for structured-syslog-tenant-record.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for structured-syslog-tenant-record.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get structured-syslog-dscpmap for structured-syslog-tenant-record.
| Returns: | StructuredSyslogDSCPMap object |
|---|
Get structured-syslog-tenant for structured-syslog-tenant-record.
| Returns: | xsd:string object |
|---|
Get structured-syslog-tenant-tags for structured-syslog-tenant-record.
| Returns: | xsd:string object |
|---|
Get structured-syslog-tenantaddr for structured-syslog-tenant-record.
| Returns: | xsd:string object |
|---|
Bases: future.types.newobject.newobject
Created By:
Type: int, within [1, 4294967295]
Created By: User (required)
Operations Allowed: CRUD
Description:
AS number of that cluster.
Type: int, within [1, 4294967295]
Created By: System
Operations Allowed: R
Description:
Unique 16 or 32 bit ID assigned to this sub-cluster. User can define the ID he wants to use.
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 sub-cluster.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for sub-cluster.
| Returns: | KeyValuePairs object |
|---|
Get display-name for sub-cluster.
| Returns: | xsd:string object |
|---|
Display sub-cluster object in compact form.
Return list of all bgp-routers using this sub-cluster
Return FQN of sub-cluster in list form.
Return FQN of sub-cluster as colon delimited string.
Return tag list for sub-cluster.
| Returns: | list of <Tag> |
|---|
Return object type (sub-cluster).
Return list of all virtual-routers using this sub-cluster
Get id-perms for sub-cluster.
| Returns: | IdPermsType object |
|---|
Get perms2 for sub-cluster.
| Returns: | PermType2 object |
|---|
Set tag for sub-cluster.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for sub-cluster.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get sub-cluster-asn for sub-cluster.
| Returns: | AutonomousSystemType object |
|---|
Get sub-cluster-id for sub-cluster.
| Returns: | SubClusterIdType object |
|---|
Bases: future.types.newobject.newobject
Created By:
Type: SubnetType
Created By: User (required)
Operations Allowed: CRD
Description:
Ip prefix/length of the subnet.
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:
Subnet belongs of the referenced virtual machine interface. This is used in CPE use case when a
subnet is reachable via the interface. It also serves as dynamic DHCP pool for host on this LAN,
where vrouter is DHCP server.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add tag to subnet.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-machine-interface to subnet.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Get annotations for subnet.
| Returns: | KeyValuePairs object |
|---|
Get display-name for subnet.
| Returns: | xsd:string object |
|---|
Display subnet object in compact form.
Return FQN of subnet in list form.
Return FQN of subnet as colon delimited string.
Return tag list for subnet.
| Returns: | list of <Tag> |
|---|
Return object type (subnet).
Return virtual-machine-interface list for subnet.
| Returns: | list of <VirtualMachineInterface> |
|---|
Get id-perms for subnet.
| Returns: | IdPermsType object |
|---|
Get perms2 for subnet.
| Returns: | PermType2 object |
|---|
Set tag for subnet.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for subnet.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-machine-interface for subnet.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Set virtual-machine-interface list for subnet.
| Parameters: | ref_obj_list – list of VirtualMachineInterface object |
|---|
Get subnet-ip-prefix for subnet.
| Returns: | SubnetType object |
|---|
Bases: future.types.newobject.newobject
Type: str
Created By: User (required)
Operations Allowed: CR
Description:
Tag type string representation
Type: str
Created By: User (required)
Operations Allowed: CR
Description:
Tag value string representation
Type: bool
Created By: User (optional)
Operations Allowed: CR
Description:
Tag delete boolean representation
Type: str, one-of xsd:string
Created By: User (optional)
Operations Allowed: R
Description:
Internal Tag ID encapsulating tag type and value in hexadecimal fomat: 0xTTTTVVVV
(T: type, V: value)
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 tag to tag.
| Parameters: | ref_obj – Tag object |
|---|
Add tag-type to tag.
| Parameters: | ref_obj – TagType object |
|---|
Get annotations for tag.
| Returns: | KeyValuePairs object |
|---|
Get display-name for tag.
| Returns: | xsd:string object |
|---|
Display tag object in compact form.
Return list of all access-control-lists using this tag
Return list of all address-groups using this tag
Return list of all alarms using this tag
Return list of all alias-ips using this tag
Return list of all alias-ip-pools using this tag
Return list of all analytics-alarm-nodes using this tag
Return list of all analytics-nodes using this tag
Return list of all analytics-snmp-nodes using this tag
Return list of all api-access-lists using this tag
Return list of all application-policy-sets using this tag
Return list of all bgp-as-a-services using this tag
Return list of all bgp-routers using this tag
Return list of all bgpvpns using this tag
Return list of all bridge-domains using this tag
Return list of all cards using this tag
Return list of all cli-configs using this tag
Return list of all config-database-nodes using this tag
Return list of all config-nodes using this tag
Return list of all config-propertiess using this tag
Return list of all config-roots using this tag
Return list of all control-node-zones using this tag
Return list of all customer-attachments using this tag
Return list of all data-center-interconnects using this tag
Return list of all database-nodes using this tag
Return list of all device-chassiss using this tag
Return list of all device-functional-groups using this tag
Return list of all device-images using this tag
Return list of all devicemgr-nodes using this tag
Return list of all discovery-service-assignments using this tag
Return list of all domains using this tag
Return list of all dsa-rules using this tag
Return list of all e2-service-providers using this tag
Return list of all fabrics using this tag
Return list of all fabric-namespaces using this tag
Return list of all features using this tag
Return list of all feature-configs using this tag
Return list of all feature-flags using this tag
Return list of all firewall-policys using this tag
Return list of all firewall-rules using this tag
Return list of all floating-ips using this tag
Return list of all floating-ip-pools using this tag
Return list of all flow-nodes using this tag
Return list of all forwarding-classs using this tag
Return FQN of tag in list form.
Return FQN of tag as colon delimited string.
Return list of all global-analytics-configs using this tag
Return list of all global-qos-configs using this tag
Return list of all global-system-configs using this tag
Return list of all global-vrouter-configs using this tag
Return list of all grpc-profiles using this tag
Return list of all hardwares using this tag
Return list of all hardware-inventorys using this tag
Return list of all host-based-services using this tag
Return list of all instance-ips using this tag
Return list of all intent-maps using this tag
Return list of all interface-route-tables using this tag
Return list of all job-templates using this tag
Return list of all link-aggregation-groups using this tag
Return list of all loadbalancers using this tag
Return list of all loadbalancer-healthmonitors using this tag
Return list of all loadbalancer-listeners using this tag
Return list of all loadbalancer-members using this tag
Return list of all loadbalancer-pools using this tag
Return list of all logical-interfaces using this tag
Return list of all logical-routers using this tag
Return list of all multicast-policys using this tag
Return list of all namespaces using this tag
Return list of all netconf-profiles using this tag
Return list of all network-device-configs using this tag
Return list of all network-ipams using this tag
Return list of all network-policys using this tag
Return list of all nodes using this tag
Return list of all node-profiles using this tag
Return list of all overlay-roles using this tag
Return FQN of tag’s parent in list form.
Return FQN of tag’s parent as colon delimted string.
Return list of all peering-policys using this tag
Return list of all physical-interfaces using this tag
Return list of all physical-roles using this tag
Return list of all physical-routers using this tag
Return list of all policy-managements using this tag
Return list of all ports using this tag
Return list of all port-groups using this tag
Return list of all port-profiles using this tag
Return list of all port-tuples using this tag
Return list of all projects using this tag
Return list of all provider-attachments using this tag
Return list of all qos-configs using this tag
Return list of all qos-queues using this tag
Return list of all role-configs using this tag
Return list of all role-definitions using this tag
Return list of all route-aggregates using this tag
Return list of all route-tables using this tag
Return list of all route-targets using this tag
Return list of all routing-instances using this tag
Return list of all routing-policys using this tag
Return list of all security-groups using this tag
Return list of all security-logging-objects using this tag
Return list of all service-appliances using this tag
Return list of all service-appliance-sets using this tag
Return list of all service-connection-modules using this tag
Return list of all service-endpoints using this tag
Return list of all service-groups using this tag
Return list of all service-health-checks using this tag
Return list of all service-instances using this tag
Return list of all service-objects using this tag
Return list of all service-templates using this tag
Return list of all sflow-profiles using this tag
Return list of all snmp-profiles using this tag
Return list of all storm-control-profiles using this tag
Return list of all structured-syslog-application-records using this tag
Return list of all structured-syslog-configs using this tag
Return list of all structured-syslog-hostname-records using this tag
Return list of all structured-syslog-messages using this tag
Return list of all structured-syslog-sla-profiles using this tag
Return list of all structured-syslog-tenant-records using this tag
Return list of all sub-clusters using this tag
Return list of all subnets using this tag
Return list of all tags using this tag
Return tag list for tag.
| Returns: | list of <Tag> |
|---|
Return list of all tag-types using this tag
Return tag-type list for tag.
| Returns: | list of <TagType> |
|---|
Return list of all telemetry-profiles using this tag
Return object type (tag).
Return list of all virtual-DNSs using this tag
Return list of all virtual-DNS-records using this tag
Return list of all virtual-ips using this tag
Return list of all virtual-machines using this tag
Return list of all virtual-machine-interfaces using this tag
Return list of all virtual-networks using this tag
Return list of all virtual-port-groups using this tag
Return list of all virtual-routers using this tag
Return list of all webui-nodes using this tag
Get id-perms for tag.
| Returns: | IdPermsType object |
|---|
Get perms2 for tag.
| Returns: | PermType2 object |
|---|
Set tag for tag.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for tag.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set tag-type for tag.
| Parameters: | ref_obj – TagType object |
|---|
Set tag-type list for tag.
| Parameters: | ref_obj_list – list of TagType object |
|---|
Get tag-id for tag.
| Returns: | U32BitHexInt object |
|---|
Get tag-predefined for tag.
| Returns: | xsd:boolean object |
|---|
Get tag-type-name for tag.
| Returns: | xsd:string object |
|---|
Get tag-value for tag.
| Returns: | xsd:string object |
|---|
Bases: future.types.newobject.newobject
Created By:
Type: str, one-of xsd:string
Created By: User (required)
Operations Allowed: R
Description:
Internal Tag type ID coded on 16 bits where the first 255 IDs are reserved
and pre-defined. Users (principally cloud admin) can define arbitrary types but its
automatically shared to all project as it is a global resource.
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 tag-type.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for tag-type.
| Returns: | KeyValuePairs object |
|---|
Get display-name for tag-type.
| Returns: | xsd:string object |
|---|
Display tag-type object in compact form.
Return FQN of tag-type in list form.
Return FQN of tag-type as colon delimited string.
Return list of all tags using this tag-type
Return tag list for tag-type.
| Returns: | list of <Tag> |
|---|
Return object type (tag-type).
Get id-perms for tag-type.
| Returns: | IdPermsType object |
|---|
Get perms2 for tag-type.
| Returns: | PermType2 object |
|---|
Set tag for tag-type.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for tag-type.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get tag-type-id for tag-type.
| Returns: | U16BitHexInt object |
|---|
Bases: future.types.newobject.newobject
Encapsulates data related to telemetry from network devices like sflow, JTI, gRPC, SNMP etc
- Created By:
- User
- Child of:
- Project object
- Properties:
- telemetry_profile_is_default
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
This attribute indicates whether it is a default telemetry profile or not. Default profiles are non-
editable.
- id_perms
Type: IdPermsType
Created By: System
Operations Allowed: RU
Description:
System maintained identity, time and permissions data.
- perms2
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
- annotations
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) on a resource.
- display_name
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
Display name user configured string(name) that can be updated any time. Used as openstack name.
Children:
- References to:
- list of SflowProfile objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Sflow profile that this telemetry profile uses. Only one sflow profile can be associated to one
telemetry profile.
- list of GrpcProfile objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
gRPC profile that this telemetry profile uses. Only one gRPC profile can be associated to one
telemetry profile.
- list of NetconfProfile objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
netconf profile that this telemetry profile uses. Only one netconf profile can be associated to one
telemetry profile.
- list of SnmpProfile objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
snmp profile that this telemetry profile uses. Only one snmp profile can be associated to one
telemetry profile.
- list of Tag objects
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
- Referred by:
- list of PhysicalRouter objects
Add grpc-profile to telemetry-profile.
| Parameters: | ref_obj – GrpcProfile object |
|---|
Add netconf-profile to telemetry-profile.
| Parameters: | ref_obj – NetconfProfile object |
|---|
Add sflow-profile to telemetry-profile.
| Parameters: | ref_obj – SflowProfile object |
|---|
Add snmp-profile to telemetry-profile.
| Parameters: | ref_obj – SnmpProfile object |
|---|
Add tag to telemetry-profile.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for telemetry-profile.
| Returns: | KeyValuePairs object |
|---|
Get display-name for telemetry-profile.
| Returns: | xsd:string object |
|---|
Display telemetry-profile object in compact form.
Return FQN of telemetry-profile in list form.
Return FQN of telemetry-profile as colon delimited string.
Return grpc-profile list for telemetry-profile.
| Returns: | list of <GrpcProfile> |
|---|
Return netconf-profile list for telemetry-profile.
| Returns: | list of <NetconfProfile> |
|---|
Return FQN of telemetry-profile’s parent in list form.
Return FQN of telemetry-profile’s parent as colon delimted string.
Return list of all physical-routers using this telemetry-profile
Return sflow-profile list for telemetry-profile.
| Returns: | list of <SflowProfile> |
|---|
Return snmp-profile list for telemetry-profile.
| Returns: | list of <SnmpProfile> |
|---|
Return tag list for telemetry-profile.
| Returns: | list of <Tag> |
|---|
Return object type (telemetry-profile).
Get id-perms for telemetry-profile.
| Returns: | IdPermsType object |
|---|
Get perms2 for telemetry-profile.
| Returns: | PermType2 object |
|---|
Set grpc-profile for telemetry-profile.
| Parameters: | ref_obj – GrpcProfile object |
|---|
Set grpc-profile list for telemetry-profile.
| Parameters: | ref_obj_list – list of GrpcProfile object |
|---|
Set netconf-profile for telemetry-profile.
| Parameters: | ref_obj – NetconfProfile object |
|---|
Set netconf-profile list for telemetry-profile.
| Parameters: | ref_obj_list – list of NetconfProfile object |
|---|
Set sflow-profile for telemetry-profile.
| Parameters: | ref_obj – SflowProfile object |
|---|
Set sflow-profile list for telemetry-profile.
| Parameters: | ref_obj_list – list of SflowProfile object |
|---|
Set snmp-profile for telemetry-profile.
| Parameters: | ref_obj – SnmpProfile object |
|---|
Set snmp-profile list for telemetry-profile.
| Parameters: | ref_obj_list – list of SnmpProfile object |
|---|
Set tag for telemetry-profile.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for telemetry-profile.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get telemetry-profile-is-default for telemetry-profile.
| Returns: | xsd:boolean object |
|---|
Bases: future.types.newobject.newobject
Virtual DNS server is DNS as service for tenants. It is inbound DNS service for virtual machines in this project. DNS requests by end points inside this project/IPAM are served by this DNS server rules.
Type: VirtualDnsType
Created By: User (required)
Operations Allowed: CRUD
Description:
Virtual DNS data has configuration for virtual DNS like domain, dynamic records 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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Static DNS records in virtual DNS server.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add tag to virtual-DNS.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for virtual-DNS.
| Returns: | KeyValuePairs object |
|---|
Get display-name for virtual-DNS.
| Returns: | xsd:string object |
|---|
Display virtual-DNS object in compact form.
Return FQN of virtual-DNS in list form.
Return FQN of virtual-DNS as colon delimited string.
Return list of all network-ipams using this virtual-DNS
Return FQN of virtual-DNS’s parent in list form.
Return FQN of virtual-DNS’s parent as colon delimted string.
Return tag list for virtual-DNS.
| Returns: | list of <Tag> |
|---|
Return object type (virtual-DNS).
Get id-perms for virtual-DNS.
| Returns: | IdPermsType object |
|---|
Get perms2 for virtual-DNS.
| Returns: | PermType2 object |
|---|
Set tag for virtual-DNS.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for virtual-DNS.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get virtual-DNS-data for virtual-DNS.
| Returns: | VirtualDnsType object |
|---|
Bases: future.types.newobject.newobject
Static DNS records in virtual DNS server.
Type: VirtualDnsRecordType
Created By: User (required)
Operations Allowed: CRUD
Description:
DNS record data has configuration like type, name, ip address, loadbalancing 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
Referred by:
Add tag to virtual-DNS-record.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for virtual-DNS-record.
| Returns: | KeyValuePairs object |
|---|
Get display-name for virtual-DNS-record.
| Returns: | xsd:string object |
|---|
Display virtual-DNS-record object in compact form.
Return FQN of virtual-DNS-record in list form.
Return FQN of virtual-DNS-record as colon delimited string.
Return FQN of virtual-DNS-record’s parent in list form.
Return FQN of virtual-DNS-record’s parent as colon delimted string.
Return tag list for virtual-DNS-record.
| Returns: | list of <Tag> |
|---|
Return object type (virtual-DNS-record).
Get id-perms for virtual-DNS-record.
| Returns: | IdPermsType object |
|---|
Get perms2 for virtual-DNS-record.
| Returns: | PermType2 object |
|---|
Set tag for virtual-DNS-record.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for virtual-DNS-record.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get virtual-DNS-record-data for virtual-DNS-record.
| Returns: | VirtualDnsRecordType object |
|---|
Bases: future.types.newobject.newobject
Virtual ip object application(protocol, port). Applicable only to LBaaS V1
Type: VirtualIpType
Created By: User (required)
Operations Allowed: CRUD
Description:
Virtual ip configuration like port, protocol, subnet 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:
Reference to the load balancer pool that this virtual ip represent. Applicable only to LBaaS V1
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to the virtual machine interface for virtual ip. Applicable only to LBaaS V1
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Referred by:
Add loadbalancer-pool to virtual-ip.
| Parameters: | ref_obj – LoadbalancerPool object |
|---|
Add tag to virtual-ip.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-machine-interface to virtual-ip.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Get annotations for virtual-ip.
| Returns: | KeyValuePairs object |
|---|
Get display-name for virtual-ip.
| Returns: | xsd:string object |
|---|
Display virtual-ip object in compact form.
Return FQN of virtual-ip in list form.
Return FQN of virtual-ip as colon delimited string.
Return loadbalancer-pool list for virtual-ip.
| Returns: | list of <LoadbalancerPool> |
|---|
Return FQN of virtual-ip’s parent in list form.
Return FQN of virtual-ip’s parent as colon delimted string.
Return tag list for virtual-ip.
| Returns: | list of <Tag> |
|---|
Return object type (virtual-ip).
Return virtual-machine-interface list for virtual-ip.
| Returns: | list of <VirtualMachineInterface> |
|---|
Get id-perms for virtual-ip.
| Returns: | IdPermsType object |
|---|
Get perms2 for virtual-ip.
| Returns: | PermType2 object |
|---|
Set loadbalancer-pool for virtual-ip.
| Parameters: | ref_obj – LoadbalancerPool object |
|---|
Set loadbalancer-pool list for virtual-ip.
| Parameters: | ref_obj_list – list of LoadbalancerPool object |
|---|
Set tag for virtual-ip.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for virtual-ip.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-machine-interface for virtual-ip.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Set virtual-machine-interface list for virtual-ip.
| Parameters: | ref_obj_list – list of VirtualMachineInterface object |
|---|
Get virtual-ip-properties for virtual-ip.
| Returns: | VirtualIpType object |
|---|
Bases: future.types.newobject.newobject
Created By:
Type: str, one-of [u’virtual-server’, u’baremetal-server’, u’container’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
An enumeration value specifying the server type.
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:
References to child interfaces this virtual machine has, this is DEPRECATED.
Created By: System
Operations Allowed: CRUD
Description:
Reference to the service instance of this virtual machine.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add service-instance to virtual-machine.
| Parameters: | ref_obj – ServiceInstance object |
|---|
Add tag to virtual-machine.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for virtual-machine.
| Returns: | KeyValuePairs object |
|---|
Get display-name for virtual-machine.
| Returns: | xsd:string object |
|---|
Display virtual-machine object in compact form.
Return FQN of virtual-machine in list form.
Return FQN of virtual-machine as colon delimited string.
Return service-instance list for virtual-machine.
| Returns: | list of <ServiceInstance> |
|---|
Return tag list for virtual-machine.
| Returns: | list of <Tag> |
|---|
Return object type (virtual-machine).
Return list of all virtual-machine-interfaces using this virtual-machine
Return list of all virtual-routers using this virtual-machine
Get id-perms for virtual-machine.
| Returns: | IdPermsType object |
|---|
Get perms2 for virtual-machine.
| Returns: | PermType2 object |
|---|
Get server-type for virtual-machine.
| Returns: | ServerType object |
|---|
Set service-instance for virtual-machine.
| Parameters: | ref_obj – ServiceInstance object |
|---|
Set service-instance list for virtual-machine.
| Parameters: | ref_obj_list – list of ServiceInstance object |
|---|
Set tag for virtual-machine.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for virtual-machine.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Bases: future.types.newobject.newobject
Type: EcmpHashingIncludeFields
Created By: User (optional)
Operations Allowed: CRUD
Description:
ECMP hashing config at global level.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Port security status on the network
Type: MacAddressesType
Created By: User (required)
Operations Allowed: CRUD
Description:
MAC address of the virtual machine interface, automatically assigned by system if not provided.
Type: DhcpOptionsListType
Created By: User (optional)
Operations Allowed: CRUD
Description:
DHCP options configuration specific to this interface.
Type: RouteTableType
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of host routes(prefixes, nexthop) that are passed to VM via DHCP.
Type: AllowedAddressPairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of (IP address, MAC) other than instance ip on this interface.
Type: VrfAssignTableType
Created By: System
Operations Allowed: CRUD
Description:
VRF assignment policy for this interface, automatically generated by system.
Type: str
Created By: User (optional)
Operations Allowed: CRUD
Description:
For openstack compatibility, not used by system.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
When True all policy checks for ingress and egress traffic from this interface are disabled. Flow
table entries are not created. Features that require policy will not work on this interface, these
include security group, floating IP, service chain, linklocal services.
Type: VirtualMachineInterfacePropertiesType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Virtual Machine Interface miscellaneous configurations.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) for this interface. Neutron port bindings use this.
Type: FatFlowProtocols
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of (protocol, port number), for flows to interface with (protocol, destination port number),
vrouter will ignore source port while setting up flow and ignore it as source port in reverse flow.
Hence many flows will map to single flow.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Enable VLAN tag based bridge domain classification on the port
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
IGMP mode at Global level.
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 security logging object for this virtual machine interface
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to QoS config for this virtual machine interface.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Interface ACL, Automatically generated by system based on security groups attached to this
interface.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of references to the sub interfaces of this interface.
Created By: User (optional)
Operations Allowed: CRUD
Description:
This interface belongs to the referenced virtual machine.
Created By: User (required)
Operations Allowed: CRUD
Description:
This interface is member of the referenced virtual network.
Created By: System
Operations Allowed: CRUD
Description:
Automatically generated Forwarding policy. This will be deprecated in future in favour of VRF assign
rules.
Created By: User (required)
Operations Allowed: CRUD
Description:
Reference to bgp-router from the virtual machine interface.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Ordered set of references to the interfaces in this port tuple.
Order is same as specified in the service interface.
example (left, right, management, other1).
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to health check object attached to this interface.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to the interface route table attached to this interface.
Created By: System
Operations Allowed: CRUD
Description:
Reference to the physical interface of service appliance this service interface represents.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Virtual Machine interface maps to a bridge-domain by defaultor based on in coming 802.1Q vlan tag
Created By: User (optional)
Operations Allowed: CRUD
Description:
Links the access endpoint i.e virtual-machine-interface to service endpoint.
Created By: User (optional)
Operations Allowed: CRUD
Description:
virtual port group to which this virtaul machine interface is attached
Created By: User (optional)
Operations Allowed: CRUD
Description:
Port profiles attached to this virtual machine interface
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add bgp-router to virtual-machine-interface.
| Parameters: | ref_obj – BgpRouter object |
|---|
Add bridge-domain to virtual-machine-interface.
| Parameters: |
|
|---|
Add interface-route-table to virtual-machine-interface.
| Parameters: | ref_obj – InterfaceRouteTable object |
|---|
Add physical-interface to virtual-machine-interface.
| Parameters: | ref_obj – PhysicalInterface object |
|---|
Add port-profile to virtual-machine-interface.
| Parameters: | ref_obj – PortProfile object |
|---|
Add port-tuple to virtual-machine-interface.
| Parameters: | ref_obj – PortTuple object |
|---|
Add qos-config to virtual-machine-interface.
| Parameters: | ref_obj – QosConfig object |
|---|
Add routing-instance to virtual-machine-interface.
| Parameters: |
|
|---|
Add security-group to virtual-machine-interface.
| Parameters: | ref_obj – SecurityGroup object |
|---|
Add security-logging-object to virtual-machine-interface.
| Parameters: | ref_obj – SecurityLoggingObject object |
|---|
Add service-endpoint to virtual-machine-interface.
| Parameters: | ref_obj – ServiceEndpoint object |
|---|
Add service-health-check to virtual-machine-interface.
| Parameters: | ref_obj – ServiceHealthCheck object |
|---|
Add tag to virtual-machine-interface.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-machine to virtual-machine-interface.
| Parameters: | ref_obj – VirtualMachine object |
|---|
Add virtual-machine-interface to virtual-machine-interface.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Add virtual-network to virtual-machine-interface.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Add virtual-port-group to virtual-machine-interface.
| Parameters: |
|
|---|
Get annotations for virtual-machine-interface.
| Returns: | KeyValuePairs object |
|---|
Get display-name for virtual-machine-interface.
| Returns: | xsd:string object |
|---|
Display virtual-machine-interface object in compact form.
Get ecmp-hashing-include-fields for virtual-machine-interface.
| Returns: | EcmpHashingIncludeFields object |
|---|
Return list of all alias-ips using this virtual-machine-interface
Return list of all bgp-as-a-services using this virtual-machine-interface
Return bgp-router list for virtual-machine-interface.
| Returns: | list of <BgpRouter> |
|---|
Return bridge-domain list for virtual-machine-interface.
| Returns: | list of tuple <BridgeDomain, BridgeDomainMembershipType> |
|---|
Return list of all customer-attachments using this virtual-machine-interface
Return list of all floating-ips using this virtual-machine-interface
Return FQN of virtual-machine-interface in list form.
Return FQN of virtual-machine-interface as colon delimited string.
Return list of all instance-ips using this virtual-machine-interface
Return interface-route-table list for virtual-machine-interface.
| Returns: | list of <InterfaceRouteTable> |
|---|
Return list of all link-aggregation-groups using this virtual-machine-interface
Return list of all loadbalancers using this virtual-machine-interface
Return list of all loadbalancer-pools using this virtual-machine-interface
Return list of all logical-interfaces using this virtual-machine-interface
Return list of all logical-routers using this virtual-machine-interface
Return FQN of virtual-machine-interface’s parent in list form.
Return FQN of virtual-machine-interface’s parent as colon delimted string.
Return physical-interface list for virtual-machine-interface.
| Returns: | list of <PhysicalInterface> |
|---|
Return port-profile list for virtual-machine-interface.
| Returns: | list of <PortProfile> |
|---|
Return port-tuple list for virtual-machine-interface.
| Returns: | list of <PortTuple> |
|---|
Return qos-config list for virtual-machine-interface.
| Returns: | list of <QosConfig> |
|---|
Return routing-instance list for virtual-machine-interface.
| Returns: | list of tuple <RoutingInstance, PolicyBasedForwardingRuleType> |
|---|
Return security-group list for virtual-machine-interface.
| Returns: | list of <SecurityGroup> |
|---|
Return security-logging-object list for virtual-machine-interface.
| Returns: | list of <SecurityLoggingObject> |
|---|
Return service-endpoint list for virtual-machine-interface.
| Returns: | list of <ServiceEndpoint> |
|---|
Return service-health-check list for virtual-machine-interface.
| Returns: | list of <ServiceHealthCheck> |
|---|
Return list of all subnets using this virtual-machine-interface
Return tag list for virtual-machine-interface.
| Returns: | list of <Tag> |
|---|
Return object type (virtual-machine-interface).
Return list of all virtual-ips using this virtual-machine-interface
Return list of all virtual-machine-interfaces using this virtual-machine-interface
Return virtual-machine-interface list for virtual-machine-interface.
| Returns: | list of <VirtualMachineInterface> |
|---|
Return virtual-machine list for virtual-machine-interface.
| Returns: | list of <VirtualMachine> |
|---|
Return virtual-network list for virtual-machine-interface.
| Returns: | list of <VirtualNetwork> |
|---|
Return list of all virtual-port-groups using this virtual-machine-interface
Return virtual-port-group list for virtual-machine-interface.
| Returns: | list of tuple <VirtualPortGroup, VMIVirtualPortGroupAttributes> |
|---|
Get id-perms for virtual-machine-interface.
| Returns: | IdPermsType object |
|---|
Get igmp-enable for virtual-machine-interface.
| Returns: | xsd:boolean object |
|---|
Get perms2 for virtual-machine-interface.
| Returns: | PermType2 object |
|---|
Get port-security-enabled for virtual-machine-interface.
| Returns: | xsd:boolean object |
|---|
Set bgp-router for virtual-machine-interface.
| Parameters: | ref_obj – BgpRouter object |
|---|
Set bgp-router list for virtual-machine-interface.
| Parameters: | ref_obj_list – list of BgpRouter object |
|---|
Set bridge-domain for virtual-machine-interface.
| Parameters: |
|
|---|
Set bridge-domain list for virtual-machine-interface.
| Parameters: |
|
|---|
Set interface-route-table for virtual-machine-interface.
| Parameters: | ref_obj – InterfaceRouteTable object |
|---|
Set interface-route-table list for virtual-machine-interface.
| Parameters: | ref_obj_list – list of InterfaceRouteTable object |
|---|
Set physical-interface for virtual-machine-interface.
| Parameters: | ref_obj – PhysicalInterface object |
|---|
Set physical-interface list for virtual-machine-interface.
| Parameters: | ref_obj_list – list of PhysicalInterface object |
|---|
Set port-profile for virtual-machine-interface.
| Parameters: | ref_obj – PortProfile object |
|---|
Set port-profile list for virtual-machine-interface.
| Parameters: | ref_obj_list – list of PortProfile object |
|---|
Set port-tuple for virtual-machine-interface.
| Parameters: | ref_obj – PortTuple object |
|---|
Set port-tuple list for virtual-machine-interface.
| Parameters: | ref_obj_list – list of PortTuple object |
|---|
Set qos-config for virtual-machine-interface.
| Parameters: | ref_obj – QosConfig object |
|---|
Set qos-config list for virtual-machine-interface.
| Parameters: | ref_obj_list – list of QosConfig object |
|---|
Set routing-instance for virtual-machine-interface.
| Parameters: |
|
|---|
Set routing-instance list for virtual-machine-interface.
| Parameters: |
|
|---|
Set security-group for virtual-machine-interface.
| Parameters: | ref_obj – SecurityGroup object |
|---|
Set security-group list for virtual-machine-interface.
| Parameters: | ref_obj_list – list of SecurityGroup object |
|---|
Set security-logging-object for virtual-machine-interface.
| Parameters: | ref_obj – SecurityLoggingObject object |
|---|
Set security-logging-object list for virtual-machine-interface.
| Parameters: | ref_obj_list – list of SecurityLoggingObject object |
|---|
Set service-endpoint for virtual-machine-interface.
| Parameters: | ref_obj – ServiceEndpoint object |
|---|
Set service-endpoint list for virtual-machine-interface.
| Parameters: | ref_obj_list – list of ServiceEndpoint object |
|---|
Set service-health-check for virtual-machine-interface.
| Parameters: | ref_obj – ServiceHealthCheck object |
|---|
Set service-health-check list for virtual-machine-interface.
| Parameters: | ref_obj_list – list of ServiceHealthCheck object |
|---|
Set tag for virtual-machine-interface.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for virtual-machine-interface.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-machine for virtual-machine-interface.
| Parameters: | ref_obj – VirtualMachine object |
|---|
Set virtual-machine-interface for virtual-machine-interface.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Set virtual-machine-interface list for virtual-machine-interface.
| Parameters: | ref_obj_list – list of VirtualMachineInterface object |
|---|
Set virtual-machine list for virtual-machine-interface.
| Parameters: | ref_obj_list – list of VirtualMachine object |
|---|
Set virtual-network for virtual-machine-interface.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Set virtual-network list for virtual-machine-interface.
| Parameters: | ref_obj_list – list of VirtualNetwork object |
|---|
Set virtual-port-group for virtual-machine-interface.
| Parameters: |
|
|---|
Set virtual-port-group list for virtual-machine-interface.
| Parameters: |
|
|---|
Get virtual-machine-interface-allowed-address-pairs for virtual-machine-interface.
| Returns: | AllowedAddressPairs object |
|---|
Get virtual-machine-interface-bindings for virtual-machine-interface.
| Returns: | KeyValuePairs object |
|---|
Get virtual-machine-interface-device-owner for virtual-machine-interface.
| Returns: | xsd:string object |
|---|
Get virtual-machine-interface-dhcp-option-list for virtual-machine-interface.
| Returns: | DhcpOptionsListType object |
|---|
Get virtual-machine-interface-disable-policy for virtual-machine-interface.
| Returns: | xsd:boolean object |
|---|
Get virtual-machine-interface-fat-flow-protocols for virtual-machine-interface.
| Returns: | FatFlowProtocols object |
|---|
Get virtual-machine-interface-host-routes for virtual-machine-interface.
| Returns: | RouteTableType object |
|---|
Get virtual-machine-interface-mac-addresses for virtual-machine-interface.
| Returns: | MacAddressesType object |
|---|
Get virtual-machine-interface-properties for virtual-machine-interface.
| Returns: | VirtualMachineInterfacePropertiesType object |
|---|
Get vlan-tag-based-bridge-domain for virtual-machine-interface.
| Returns: | xsd:boolean object |
|---|
Get vrf-assign-table for virtual-machine-interface.
| Returns: | VrfAssignTableType object |
|---|
Bases: future.types.newobject.newobject
Virtual network is collection of end points (interface or ip(s) or MAC(s)) that can talk to each other by default. It is collection of subnets connected by implicit router which default gateway in each subnet.
Type: EcmpHashingIncludeFields
Created By: User (optional)
Operations Allowed: CRUD
Description:
ECMP hashing config at global level.
Type: str, one-of [u’infra’, u’tenant’, u’internal’, u’routed’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
This attribute is to differentiate the infrastructure networks from the tenant and routed networks.
Infra-networks could be in-band network for management and control traffic
Type: VirtualNetworkType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Virtual network miscellaneous configurations.
Type: VirtualNetworkRoutedPropertiesType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Attributes for routed virtual networks.
Type: ProviderDetails
Created By: User (optional)
Operations Allowed: CRD
Description:
Virtual network is provider network. Specifies VLAN tag and physical network name.
Type: int
Created By: System
Operations Allowed: CR
Description:
System assigned unique 32 bit ID for every virtual network.
Type: bool
Created By: User (optional)
Operations Allowed: R
Description:
provider network status of the virtual-network.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Port security status on the network
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Provide connectivity to underlay network by port mapping
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: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
When true, this virtual network is openstack router external network.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
When true, this virtual network is shared with all tenants.
Type: int, within [0, 9216]
Created By: User (optional)
Operations Allowed: CRUD
Description:
MTU attribute for the virtual network
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
IP address assignment to VM is done statically, outside of (external to) Contrail Ipam. vCenter only
feature.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
When true, packets with unknown unicast MAC address are flooded within the network. Default they are
dropped.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Allow multiple service chains within same two networks based on network policy.
Current limitation is that both networks must reside within cluster, except when right most service
is NAT.
Type: str, one-of [u’user-defined-subnet-preferred’, u’user-defined-subnet-only’, u’flat-subnet-preferred’, u’flat-subnet-only’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Address allocation mode for virtual network.
Type: FatFlowProtocols
Created By: User (optional)
Operations Allowed: CRUD
Description:
Fat flow configuration which is a list, will be applied to all the interfaces in the specified
virtual-network
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: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Enable/Disable PBB EVPN tunneling on the network
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Enable/Disable PBB ETREE mode on the network
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Enable/Disable adding control word to the Layer 2 encapsulation
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:
Enable/Disable MAC-IP Learning on the 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: System
Operations Allowed: CRUD
Description:
Virtual network access control list are automatically derived from all the network policies attached
to virtual network.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Floating ip pool is set of ip address that are carved out of a given network. Ip(s) from this set
can be assigned to (virtual machine interface, ip) so that they become members of this network using
one:one NAT.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Alias ip pool is set of addresses that are carved out of a given network. Ip(s) from this set can be
assigned to virtual-machine-interface so that they become members of this network
Created By: System
Operations Allowed: CRUD
Description:
List of references of routing instances for this virtual network, routing instances are internal to
the system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
bridge-domains configured in a virtual network
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to security logging object for this virtual network.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to QoS configuration for this virtual network.
Created By: User (required)
Operations Allowed: CRUD
Description:
Reference to network-ipam this network is using. It has list of subnets that are to be used as
property of the reference.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to network-policy attached to this network. It has sequence number to specify attachment
order.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to a virtual network which is the provider network for the given virtual network. Traffic
forwarding happens in the routing instance of the provider network.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to health check object attached to VN object, used to enable BFD health check over MAC IP
Learnt IP Addresses of VN.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to route table attached to this virtual network.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to multicast policy. Each multicast policy has a list of (S,G) Addresses.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Back reference to virtual network associated to the BGP VPN resource
Created By: User (optional)
Operations Allowed: CRUD
Description:
All virtual-network objects that get created in the fabric
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of references of routing policy objects. imported by user.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add bgpvpn to virtual-network.
| Parameters: | ref_obj – Bgpvpn object |
|---|
Add intent-map to virtual-network.
| Parameters: | ref_obj – IntentMap object |
|---|
Add multicast-policy to virtual-network.
| Parameters: | ref_obj – MulticastPolicy object |
|---|
Add network-ipam to virtual-network.
| Parameters: |
|
|---|
Add network-policy to virtual-network.
| Parameters: |
|
|---|
Add qos-config to virtual-network.
| Parameters: | ref_obj – QosConfig object |
|---|
Add route-table to virtual-network.
| Parameters: | ref_obj – RouteTable object |
|---|
Add routing-policy to virtual-network.
| Parameters: |
|
|---|
Add security-logging-object to virtual-network.
| Parameters: | ref_obj – SecurityLoggingObject object |
|---|
Add service-health-check to virtual-network.
| Parameters: | ref_obj – ServiceHealthCheck object |
|---|
Add tag to virtual-network.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-network to virtual-network.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Get address-allocation-mode for virtual-network.
| Returns: | AddressAllocationModeType object |
|---|
Get annotations for virtual-network.
| Returns: | KeyValuePairs object |
|---|
Get display-name for virtual-network.
| Returns: | xsd:string object |
|---|
Display virtual-network object in compact form.
Get ecmp-hashing-include-fields for virtual-network.
| Returns: | EcmpHashingIncludeFields object |
|---|
Get export-route-target-list for virtual-network.
| Returns: | RouteTargetList object |
|---|
Get external-ipam for virtual-network.
| Returns: | xsd:boolean object |
|---|
Get fabric-snat for virtual-network.
| Returns: | xsd:boolean object |
|---|
Get flood-unknown-unicast for virtual-network.
| Returns: | xsd:boolean object |
|---|
Return bgpvpn list for virtual-network.
| Returns: | list of <Bgpvpn> |
|---|
Return list of all data-center-interconnects using this virtual-network
Return list of all fabrics using this virtual-network
Return list of all firewall-rules using this virtual-network
Return list of all flow-nodes using this virtual-network
Return FQN of virtual-network in list form.
Return FQN of virtual-network as colon delimited string.
Return list of all host-based-services using this virtual-network
Return list of all instance-ips using this virtual-network
Return intent-map list for virtual-network.
| Returns: | list of <IntentMap> |
|---|
Return list of all logical-routers using this virtual-network
Return multicast-policy list for virtual-network.
| Returns: | list of <MulticastPolicy> |
|---|
Return network-ipam list for virtual-network.
| Returns: | list of tuple <NetworkIpam, VnSubnetsType> |
|---|
Return network-policy list for virtual-network.
| Returns: | list of tuple <NetworkPolicy, VirtualNetworkPolicyType> |
|---|
Return FQN of virtual-network’s parent in list form.
Return FQN of virtual-network’s parent as colon delimted string.
Return list of all physical-routers using this virtual-network
Return list of all port-tuples using this virtual-network
Return qos-config list for virtual-network.
| Returns: | list of <QosConfig> |
|---|
Return route-table list for virtual-network.
| Returns: | list of <RouteTable> |
|---|
Return routing-policy list for virtual-network.
| Returns: | list of tuple <RoutingPolicy, RoutingPolicyType> |
|---|
Return security-logging-object list for virtual-network.
| Returns: | list of <SecurityLoggingObject> |
|---|
Return service-health-check list for virtual-network.
| Returns: | list of <ServiceHealthCheck> |
|---|
Return tag list for virtual-network.
| Returns: | list of <Tag> |
|---|
Return object type (virtual-network).
Return list of all virtual-machine-interfaces using this virtual-network
Return list of all virtual-networks using this virtual-network
Return virtual-network list for virtual-network.
| Returns: | list of <VirtualNetwork> |
|---|
Get id-perms for virtual-network.
| Returns: | IdPermsType object |
|---|
Get igmp-enable for virtual-network.
| Returns: | xsd:boolean object |
|---|
Get import-route-target-list for virtual-network.
| Returns: | RouteTargetList object |
|---|
Get is-provider-network for virtual-network.
| Returns: | xsd:boolean object |
|---|
Get is-shared for virtual-network.
| Returns: | xsd:boolean object |
|---|
Get layer2-control-word for virtual-network.
| Returns: | xsd:boolean object |
|---|
Get mac-aging-time for virtual-network.
| Returns: | MACAgingTime object |
|---|
Get mac-ip-learning-enable for virtual-network.
| Returns: | xsd:boolean object |
|---|
Get mac-learning-enabled for virtual-network.
| Returns: | xsd:boolean object |
|---|
Get mac-limit-control for virtual-network.
| Returns: | MACLimitControlType object |
|---|
Get mac-move-control for virtual-network.
| Returns: | MACMoveLimitControlType object |
|---|
Get mtu for virtual-network.
| Returns: | NetworkMtuType object |
|---|
Get multi-policy-service-chains-enabled for virtual-network.
| Returns: | xsd:boolean object |
|---|
Get pbb-etree-enable for virtual-network.
| Returns: | xsd:boolean object |
|---|
Get pbb-evpn-enable for virtual-network.
| Returns: | xsd:boolean object |
|---|
Get perms2 for virtual-network.
| Returns: | PermType2 object |
|---|
Get port-security-enabled for virtual-network.
| Returns: | xsd:boolean object |
|---|
Get provider-properties for virtual-network.
| Returns: | ProviderDetails object |
|---|
Get route-target-list for virtual-network.
| Returns: | RouteTargetList object |
|---|
Get router-external for virtual-network.
| Returns: | xsd:boolean object |
|---|
Set bgpvpn for virtual-network.
| Parameters: | ref_obj – Bgpvpn object |
|---|
Set bgpvpn list for virtual-network.
| Parameters: | ref_obj_list – list of Bgpvpn object |
|---|
Set intent-map for virtual-network.
| Parameters: | ref_obj – IntentMap object |
|---|
Set intent-map list for virtual-network.
| Parameters: | ref_obj_list – list of IntentMap object |
|---|
Set multicast-policy for virtual-network.
| Parameters: | ref_obj – MulticastPolicy object |
|---|
Set multicast-policy list for virtual-network.
| Parameters: | ref_obj_list – list of MulticastPolicy object |
|---|
Set network-ipam for virtual-network.
| Parameters: |
|
|---|
Set network-ipam list for virtual-network.
| Parameters: |
|
|---|
Set network-policy for virtual-network.
| Parameters: |
|
|---|
Set network-policy list for virtual-network.
| Parameters: |
|
|---|
Set qos-config for virtual-network.
| Parameters: | ref_obj – QosConfig object |
|---|
Set qos-config list for virtual-network.
| Parameters: | ref_obj_list – list of QosConfig object |
|---|
Set route-table for virtual-network.
| Parameters: | ref_obj – RouteTable object |
|---|
Set route-table list for virtual-network.
| Parameters: | ref_obj_list – list of RouteTable object |
|---|
Set routing-policy for virtual-network.
| Parameters: |
|
|---|
Set routing-policy list for virtual-network.
| Parameters: |
|
|---|
Set security-logging-object for virtual-network.
| Parameters: | ref_obj – SecurityLoggingObject object |
|---|
Set security-logging-object list for virtual-network.
| Parameters: | ref_obj_list – list of SecurityLoggingObject object |
|---|
Set service-health-check for virtual-network.
| Parameters: | ref_obj – ServiceHealthCheck object |
|---|
Set service-health-check list for virtual-network.
| Parameters: | ref_obj_list – list of ServiceHealthCheck object |
|---|
Set tag for virtual-network.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for virtual-network.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-network for virtual-network.
| Parameters: | ref_obj – VirtualNetwork object |
|---|
Set virtual-network list for virtual-network.
| Parameters: | ref_obj_list – list of VirtualNetwork object |
|---|
Get virtual-network-category for virtual-network.
| Returns: | VirtualNetworkCategory object |
|---|
Get virtual-network-fat-flow-protocols for virtual-network.
| Returns: | FatFlowProtocols object |
|---|
Get virtual-network-network-id for virtual-network.
| Returns: | xsd:integer object |
|---|
Get virtual-network-properties for virtual-network.
| Returns: | VirtualNetworkType object |
|---|
Get virtual-network-routed-properties for virtual-network.
| Returns: | VirtualNetworkRoutedPropertiesType object |
|---|
Bases: future.types.newobject.newobject
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: str
Created By: User (required)
Operations Allowed: CR
Description:
id of the port that enables multi valn trunking.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Flag to be set to True when its externally created and False when created internally. Default is set
to True
Type: str, one-of [u’access’, u’routed’]
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type of Virtual port group. It can be either access i.e L2 connectivity or routed.
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 physical interfaces that belong to this link aggregation group. The physical interface could
belong to the same or different physical router
Created By: User (optional)
Operations Allowed: CRUD
Description:
list of virtual machine interfaces that are part of this virtual port group
Created By: User (optional)
Operations Allowed: CRUD
Description:
Interface ACL, automatically generated by system based on security groups attached to this virtual
port group.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Port profiles attached to this virtual port group
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add physical-interface to virtual-port-group.
| Parameters: |
|
|---|
Add port-profile to virtual-port-group.
| Parameters: | ref_obj – PortProfile object |
|---|
Add security-group to virtual-port-group.
| Parameters: | ref_obj – SecurityGroup object |
|---|
Add tag to virtual-port-group.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-machine-interface to virtual-port-group.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Get annotations for virtual-port-group.
| Returns: | KeyValuePairs object |
|---|
Get display-name for virtual-port-group.
| Returns: | xsd:string object |
|---|
Display virtual-port-group object in compact form.
Return FQN of virtual-port-group in list form.
Return FQN of virtual-port-group as colon delimited string.
Return FQN of virtual-port-group’s parent in list form.
Return FQN of virtual-port-group’s parent as colon delimted string.
Return physical-interface list for virtual-port-group.
| Returns: | list of tuple <PhysicalInterface, VpgInterfaceParametersType> |
|---|
Return port-profile list for virtual-port-group.
| Returns: | list of <PortProfile> |
|---|
Return security-group list for virtual-port-group.
| Returns: | list of <SecurityGroup> |
|---|
Return tag list for virtual-port-group.
| Returns: | list of <Tag> |
|---|
Return object type (virtual-port-group).
Return list of all virtual-machine-interfaces using this virtual-port-group
Return virtual-machine-interface list for virtual-port-group.
| Returns: | list of <VirtualMachineInterface> |
|---|
Get id-perms for virtual-port-group.
| Returns: | IdPermsType object |
|---|
Get perms2 for virtual-port-group.
| Returns: | PermType2 object |
|---|
Set physical-interface for virtual-port-group.
| Parameters: |
|
|---|
Set physical-interface list for virtual-port-group.
| Parameters: |
|
|---|
Set port-profile for virtual-port-group.
| Parameters: | ref_obj – PortProfile object |
|---|
Set port-profile list for virtual-port-group.
| Parameters: | ref_obj_list – list of PortProfile object |
|---|
Set security-group for virtual-port-group.
| Parameters: | ref_obj – SecurityGroup object |
|---|
Set security-group list for virtual-port-group.
| Parameters: | ref_obj_list – list of SecurityGroup object |
|---|
Set tag for virtual-port-group.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for virtual-port-group.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-machine-interface for virtual-port-group.
| Parameters: | ref_obj – VirtualMachineInterface object |
|---|
Set virtual-machine-interface list for virtual-port-group.
| Parameters: | ref_obj_list – list of VirtualMachineInterface object |
|---|
Get virtual-port-group-lacp-enabled for virtual-port-group.
| Returns: | xsd:boolean object |
|---|
Get virtual-port-group-trunk-port-id for virtual-port-group.
| Returns: | xsd:string object |
|---|
Get virtual-port-group-type for virtual-port-group.
| Returns: | VpgType object |
|---|
Get virtual-port-group-user-created for virtual-port-group.
| Returns: | xsd:boolean object |
|---|
Bases: future.types.newobject.newobject
Virtual router is packet forwarding system on devices such as compute nodes(servers), TOR(s), routers.
Type: str, one-of [u’embedded’, u’tor-agent’, u’tor-service-node’]
Created By: User (optional)
Operations Allowed: CRD
Description:
Different types of the vrouters in the system.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
This vrouter’s data path is using DPDK library, Virtual machines interfaces scheduled on this
compute node will be tagged with additional flags so that they are spawned with user space virtio
driver. It is only applicable for embedded vrouter.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of (physnet, interface) mapping for this virtual router.
Type: str, one-of xsd:string
Created By: User (required)
Operations Allowed: CRUD
Description:
Ip address of the virtual router.
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:
An interface on a virtual-router, e.g. vhost0
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to network-ipam this virtual-router is using. It has list of virtual-router specific
allocation-pools and cidrs that are to be used as property of the reference.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference of vrouter to sub-cluster.
Created By: User (optional)
Operations Allowed: CRUD
Description:
References to all virtual machines on this vrouter. This link is not present for dynamically
scheduled VMs by Nova.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Tag attached to an object - has a type and value
Add network-ipam to virtual-router.
| Parameters: |
|
|---|
Add sub-cluster to virtual-router.
| Parameters: | ref_obj – SubCluster object |
|---|
Add tag to virtual-router.
| Parameters: | ref_obj – Tag object |
|---|
Add virtual-machine to virtual-router.
| Parameters: | ref_obj – VirtualMachine object |
|---|
Get annotations for virtual-router.
| Returns: | KeyValuePairs object |
|---|
Get display-name for virtual-router.
| Returns: | xsd:string object |
|---|
Display virtual-router object in compact form.
Return FQN of virtual-router in list form.
Return FQN of virtual-router as colon delimited string.
Return list of all instance-ips using this virtual-router
Return network-ipam list for virtual-router.
| Returns: | list of tuple <NetworkIpam, VirtualRouterNetworkIpamType> |
|---|
Return FQN of virtual-router’s parent in list form.
Return FQN of virtual-router’s parent as colon delimted string.
Return list of all physical-routers using this virtual-router
Return list of all provider-attachments using this virtual-router
Return sub-cluster list for virtual-router.
| Returns: | list of <SubCluster> |
|---|
Return tag list for virtual-router.
| Returns: | list of <Tag> |
|---|
Return object type (virtual-router).
Return virtual-machine list for virtual-router.
| Returns: | list of <VirtualMachine> |
|---|
Get id-perms for virtual-router.
| Returns: | IdPermsType object |
|---|
Get perms2 for virtual-router.
| Returns: | PermType2 object |
|---|
Set network-ipam for virtual-router.
| Parameters: |
|
|---|
Set network-ipam list for virtual-router.
| Parameters: |
|
|---|
Set sub-cluster for virtual-router.
| Parameters: | ref_obj – SubCluster object |
|---|
Set sub-cluster list for virtual-router.
| Parameters: | ref_obj_list – list of SubCluster object |
|---|
Set tag for virtual-router.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for virtual-router.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Set virtual-machine for virtual-router.
| Parameters: | ref_obj – VirtualMachine object |
|---|
Set virtual-machine list for virtual-router.
| Parameters: | ref_obj_list – list of VirtualMachine object |
|---|
Get virtual-router-dpdk-enabled for virtual-router.
| Returns: | xsd:boolean object |
|---|
Get virtual-router-ip-address for virtual-router.
| Returns: | IpAddressType object |
|---|
Get virtual-router-sriov-physical-networks for virtual-router.
| Returns: | KeyValuePairs object |
|---|
Get virtual-router-type for virtual-router.
| Returns: | VirtualRouterType object |
|---|
Bases: future.types.newobject.newobject
WebUI node is object representing a logical node in system which hosts the Contrail UI.
Type: str, one-of xsd:string
Created By: User (required)
Operations Allowed: CRUD
Description:
Ip address of the webui 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 webui-node.
| Parameters: | ref_obj – Tag object |
|---|
Get annotations for webui-node.
| Returns: | KeyValuePairs object |
|---|
Get display-name for webui-node.
| Returns: | xsd:string object |
|---|
Display webui-node object in compact form.
Return FQN of webui-node in list form.
Return FQN of webui-node as colon delimited string.
Return FQN of webui-node’s parent in list form.
Return FQN of webui-node’s parent as colon delimted string.
Return tag list for webui-node.
| Returns: | list of <Tag> |
|---|
Return object type (webui-node).
Get id-perms for webui-node.
| Returns: | IdPermsType object |
|---|
Get perms2 for webui-node.
| Returns: | PermType2 object |
|---|
Set tag for webui-node.
| Parameters: | ref_obj – Tag object |
|---|
Set tag list for webui-node.
| Parameters: | ref_obj_list – list of Tag object |
|---|
Get webui-node-ip-address for webui-node.
| Returns: | IpAddressType object |
|---|
This module defines the classes for types defined in vnc_cfg.xsd
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * dynamic
Type: bool
Created By: User (optional)
- Description:
- For Internal use only
Type: AclRuleType
Created By: User (required)
For Internal use only
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * match_condition
Type: ActionListType
Created By: User (required)
Actions to be performed if packets match condition
Type: str
Created By: User (optional)
Rule UUID is identifier used in flow records to identify rule
Type: str, one-of [u’>’, u’<>’]
Created By: User (optional)
Direction in the rule
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * expand
Type: AsListType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * add
Type: CommunityListType
Type: CommunityListType
Type: CommunityListType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * add
Type: ExtCommunityListType
Type: ExtCommunityListType
Type: ExtCommunityListType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * simple_action
Type: str, one-of [u’deny’, u’pass’]
Created By: User (required)
- Description:
- Simple allow(pass) or deny action for traffic matching this rule
Type: str
Created By: User (optional)
For internal use only
Type: str
Created By: User (optional)
Ordered list of service instances in service chain applied to traffic matching
the rule
Type: ServicePropertiesType
Created By: User (optional)
Properties of the service-policy if action is apply-service
Type: MirrorActionType
Created By: User (optional)
Mirror traffic matching this rule
Type: str
Created By: User (optional)
For internal use only
Type: bool
Created By: User (optional)
Flow records for traffic matching this rule are sent at higher priority
Type: bool
Created By: User (optional)
For internal use only
Type: str
Created By: User (optional)
FQN of Qos configuration object for QoS marking
Type: bool
Forward traffic matching this rule to the project’s host based service
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * as_path
Type: ActionAsPathType
Type: ActionCommunityType
Type: ActionExtCommunityType
Type: int
Type: int
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * family
Type: str, one-of [u’inet’, u’inet-labeled’, u’inet-vpn’, u’e-vpn’, u’erm-vpn’, u’route-target’, u’inet6’, u’inet-mvpn’, u’inet6-vpn’]
- Description:
- BGP address families supported by contrail.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * subnet
Type: str
Created By: User (optional)
Any address that belongs to this virtual network
Type: str
Created By: User (optional)
Any address that belongs to interface with this security-group
Type: str
Created By: User (optional)
Any address that belongs to virtual network which has this policy attached
Type: SubnetType
Created By: User (optional)
Any address that belongs to any one of subnet in this list
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * and_list
Type: AlarmExpression
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * operation
Type: str, one-of [u’==’, u’!=’, u’<’, u’<=’, u’>’, u’>=’, u’in’, u’not in’, u’range’, u’size==’, u’size!=’]
Created By: User (required)
- Description:
- operation to compare operand1 and operand2
Type: str
Created By: User (required)
UVE attribute specified in the dotted format. Example:
NodeStatus.process_info.process_state
Type: AlarmOperand2
Created By: User (required)
UVE attribute or a json value to compare with the UVE attribute in operand1
Type: str
Created By: User (optional)
List of UVE attributes that would be useful when the alarm is raised. For
example, user may want to raise an alarm if the
NodeStatus.process_info.process_state != PROCESS_STATE_RUNNING. But, it would be
useful to know the process_name whose state != PROCESS_STATE_RUNNING. This UVE
attribute which is neither part of operand1 nor operand2 may be specified in
variables
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * uve_attribute
Type: str
Created By: User (optional)
- Description:
UVE attribute specified in the dotted format. Example:
NodeStatus.process_info.process_state
Type: str
Created By: User (optional)
json value as string
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * or_list
Type: AlarmAndList
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * start
Type: str
Type: str
Type: bool
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * ip
Type: SubnetType
Type: str
Created By: User (optional)
Type: str, one-of [u’active-active’, u’active-standby’]
Created By: User (optional)
Address-mode active-backup is used for VRRP address.
Address-mode active-active is used for ECMP.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * allowed_address_pair
Type: AllowedAddressPair
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * api_access
Type: ApiAccessType
Created By: User (required)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * api_name
Type: str
Created By: User (required)
Type: PermType
Created By: User (required)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * asn_list
Type: int
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * asn_min
Type: int
Type: int
Bases: gen.generatedssuper.GeneratedsSuper
Attributes:
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * static
Type: ProtocolStaticType
Type: ProtocolBgpType
Type: ProtocolOspfType
Type: str, one-of xsd:string
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * key_type
Type: str, one-of [u’md5’]
Created By: User (required)
- Description:
- Authentication type for this session. Currently only MD5 is supported.
Type: AuthenticationKeyItem
Created By: User (required)
Upto two keys can be specified. Currently only one key is supported.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * key_id
Type: int, within [0, 63]
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * asn
Type: int, within [1, 4294967295]
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * bgpaas_control_node_zone_type
Type: str, one-of [u’primary’, u’secondary’]
Created By: User (optional)
- Description:
Specifies BGPaaSControlNodeZoneType. If bgpaas uses x.x.x.1 ip for
peering, BGPaaSControlNodeZoneType should be set to primary. If it
is x.x.x.2 ip for peering, BGPaaSControlNodeZoneType should be
secondary
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * port_start
Type: int, within [-1, 65535]
Type: int, within [-1, 65535]
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * standalone_ports_supported
Type: bool
- Description:
Indicates whether ports that are members of this portgroup can be used as stand-
alone ports.
Type: str
UUID of the parent node where this port is connected
Type: PortGroupProperties
Key/value properties related to the port group’s configuration.
Type: str
Mac Address of the NIC in Node
Type: str
Mode of the port group
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * pxe_enabled
Type: bool
- Description:
- Indicates whether PXE is enabled or disabled on the Port.
Type: LocalLinkConnection
The Port binding profile
Type: str
UUID of the parent node where this port is connected
Type: str
Mac Address of the NIC in Node
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * memory_mb
Type: int
- Description:
- RAM of the Baremetal server (in MB)
Type: str
Architecture of the baremetal server
Type: int
Disk size of root device (in GB)
Type: int
Number of CPU cores on the baremetal
Type: str
Boot option
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * network_interface
Type: str
- Description:
- Networking interface
Type: str
IPMI driver
Type: BaremetalProperties
Details of baremetal hardware for scheduler
Type: DriverInfo
Details of the driver for power management
Type: str
Name of the Baremetal server
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * time_interval
Type: int
Created By: User (optional)
- Description:
- Rx/Tx time interval for BFD session in milliseconds.
Type: int
Created By: User (optional)
Detection time multiplier for BFD session.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * address_family
Type: str, one-of [u’inet’, u’inet-labeled’, u’inet-vpn’, u’e-vpn’, u’erm-vpn’, u’route-target’, u’inet6’, u’inet-mvpn’, u’inet6-vpn’]
Created By: User (required)
- Description:
- Address family for which these parameters are applied.
Type: int, within [0, 16]
Created By: User (optional)
For routing loop detection, loop-count is the number of times the local bgp-
routers AS is allowed in the AS_PATH attribute.
Type: BgpPrefixLimit
Created By: User (optional)
prefix-limit contains the maximum number of prefixes that are allowed to be
received on the session for this address family.
Type: str, one-of [u’gre’, u’mpls’, u’udp’, u’vxlan’]
Created By: User (optional)
Default prioritized tunnel encapsulation list.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * peer_autonomous_system
Type: int
Created By: User (required)
- Description:
- Peer autonomous system number for this eBGP session.
Type: str, one-of xsd:string
Created By: User (optional)
Peer ip address used for this eBGP session.
Type: str, one-of xsd:string
Created By: User (required)
Peer ip address list used for this eBGP session.
Type: int, within [0, 65535]
Created By: User (optional)
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: AuthenticationData
Created By: User (optional)
Authentication related configuration like type, keys etc.
Type: int
Created By: User (optional)
BgpRouter specific Autonomous System number if different from global AS number.
Type: int
Created By: User (optional)
time-to-live (TTL) value in the BGP packets to control how far they propagate.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * session
Type: BgpSession
Created By: User (required)
- Description:
List of BGP sessions parameters. There can be multiple BGP sessions between two
BGP routers. Currently only 1 session is supported.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * maximum
Type: int
Type: int, within [0, 86400]
Created By: User (optional)
Time in seconds after which the session is allowed to re-establish after
teardown.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * admin_down
Type: bool
Created By: User (optional)
- Description:
- Administratively up or down.
Type: str
Created By: User (optional)
Vendor name for this BGP router, contrail, juniper or cisco etc.
Type: int
Created By: User (optional)
Cluster Id for this BGP router.
Type: int
Created By: User (required)
Autonomous System number for this BGP router. Currently only 16 bit AS number is
supported. For contrail control nodes this has to be equal to global AS number.
Type: str, one-of xsd:string
Created By: User (required)
Router ID for this BGP router. Dotted ip notation. For contrail control-nodes
System will automatically assign value of address field.
Type: str, one-of xsd:string
Created By: User (required)
Ip address used to reach this BGP router by the system.
Type: int
Created By: User (optional)
TCP port number on which BGP protocol connections are accepted. default is based
on standareds.
Type: int
For system internal use in BGPaaS service.
Type: int, within [0, 65535]
Created By: User (optional)
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: AddressFamilies
Created By: User (optional)
BGP address families supported by BGP router
Type: AuthenticationData
Created By: User (optional)
Authentication related configuration like type, keys etc.
Type: int
Created By: User (optional)
BgpRouter specific Autonomous System number if different from global AS number.
Typically used when clusters of control nodes in same contrail system are in
different locations. Currently only 16 bit AS number is supported.
Type: str, one-of [u’control-node’, u’external-control-node’, u’router’, u’bgpaas-server’, u’bgpaas-client’]
Created By: User (optional)
BGP router type.
Type: str, one-of xsd:string
Created By: User (optional)
gateway-address field is used only for router-type bgpaas-client. It holds the
ipv4 gateway address for the ipv4 subnet from which the client has IP address.
The value is used as nexthop when advertising routes to the client via bgp.
Type: str, one-of xsd:string
Created By: User (optional)
The ipv6-gateway-address field is used only for router-type bgpaas-client. It
holds ipv6 gateway address for ipv6 subnet from which the client has IP address.
The value is used as nexthop when advertising routes to the client via bgp.
Note that the ipv6-gateway-address can be a regular ipv6 address or a ipv4
-mapped-ipv6 adddress.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * uuid
Type: str
Created By: User (required)
- Description:
- When multiple sessions are present, each session must have an unique id.
Type: BgpSessionAttributes
Created By: User (required)
There can be upto 3 instances BGP session attributes, representing configuration
for both ends and common. Currently only 1 instance representing common
attributes is supported.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * bgp_router
Type: str
Created By: User (optional)
- Description:
When the parameters are uni-directional the bgp-router element specifies to
which node the configuration applies. If missing the attributes apply to both
ends of the session.
Type: bool
Created By: User (optional)
Administratively mark this session down.
Type: bool
Created By: User (optional)
This is passive session. It will not initiated connection. This is not relevant
when session attributes represent common part. It is recommended that it should
not be set to true in current release.
Type: bool
Created By: User (optional)
To Be Added
Type: int, within [0, 65535]
Created By: User (optional)
A non-zero hold-time overrides the hold-time inherited from the bgp-router
configuration. BGP hold time in seconds [0-65535], Max time to detect liveliness
of peer.
Type: int, within [0, 16]
Created By: User (optional)
For routing loop detection, loop-count is the number of times the local AS is
allowed in the AS_PATH attribute.
Type: int
Created By: User (optional)
Local autonomous system number used for this particular session. If configured,
this overrides autonomous-system number and local-autonomous-system number
configured under BgpRouterParams
Type: AddressFamilies
Created By: User (optional)
BGP address families supported on this session.
Type: AuthenticationData
Created By: User (optional)
Authentication related configuration for this session like type, keys etc.
Type: BgpFamilyAttributes
Created By: User (optional)
Session attributes over ride per BGP address family. Attributes like address
family, loop-count and prefix-limit.
Type: str, one-of [u’remove’, u’remove-all’, u’replace-all’]
Created By: User (optional)
Remove or replace private ASes from AS Path attributes advertised to this
session.
Type: RouteOriginOverride
Created By: User (optional)
User defined route origin value to override
Bases: gen.generatedssuper.GeneratedsSuper
Attributes:
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * vlan_tag
Type: int, within [0, 4094]
- Description:
VLAN tag of the incoming packet that maps the virtual-
machine-interface to bridge domain
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * username
Type: str
Type: str
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * commit_diff_info
Type: CliDiffInfoType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * os_version
Type: str
- Description:
- specific version of operating system
Type: str
Name of operating system, ex - centos7 or ubuntu16
Type: None
Roles of the cloud instance
Type: str
Availability zone to which the instance belongs to
Type: str
size of instance
Type: str
image (ami) id of instance
Type: int
Size of the volume for the cloud instance
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * community_attribute
Type: str, one-of xsd:string
- Description:
List of Community attributes, it indicates the attributes with which the routes
are tagged while publishing.
The attributes will be represented as bgp community in the path attribute.
Each attribute is indicated as string.
String with two integers separated by ”:”. E.g. “64512:123”
Well-known community as string.
Possible values are “no-export” “accept-own” “no-advertise” “no-export-
subconfed” “no-reoriginate”
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * community
Type: str, one-of xsd:string
- Description:
List of Community attributes, it indicates the attributes with which the routes
are tagged while publishing.
The attributes will be represented as bgp community in the path attribute.
Each attribute is indicated as string.
String with two integers separated by ”:”. E.g. “64512:123”
Well-known community as string.
Possible values are “no-export” “accept-own” “no-advertise” “no-export-
subconfed” “no-reoriginate”
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * destination_instance
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * control
Type: int, within [0, 63]
Created By: User (optional)
- Description:
- DSCP value for control protocols traffic
Type: int, within [0, 63]
Created By: User (optional)
DSCP value for traffic towards analytics
Type: int, within [0, 63]
Created By: User (optional)
DSCP value for DNS traffic
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * bgp
Type: ProtocolBgpType
Type: ProtocolOspfType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * credential
Type: UserCredentials
Created By: User (required)
Type: str
Created By: User (optional)
Type: str
Created By: User (optional)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * device_credential
Type: DeviceCredential
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * device_family
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * platform_name
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * dhcp_option_name
Type: str
Created By: User (required)
- Description:
- Name of the DHCP option
Type: str
Created By: User (required)
Encoded DHCP option value (decimal)
Type: str
Created By: User (required)
Value of the DHCP option to be copied byte by byte
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * dhcp_option
Type: DhcpOptionType
- Description:
- List of DHCP options
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * ep_type
Type: str
Created By: User (required)
- Description:
- Type of service or client
Type: str
Created By: User (optional)
Specific service or client which is set of one.
Type: SubnetType
Created By: User (optional)
All servers or clients whose ip match this prefix
Type: str
Created By: User (optional)
All servers or clients whose version match this version
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * publisher
Type: DiscoveryPubSubEndPointType
Created By: User (required)
subscriber set
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * negative_cache_ttl_seconds
Type: int
Created By: User (optional)
- Description:
- Default Time To Live for negative caching of DNS queries
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * lease_expiry_time
Type: int
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * project_limit
Type: int
Created By: User (optional)
- Description:
- Maximum number of projects allowed in this domain
Type: int
Created By: User (optional)
Maximum number of virtual networks allowed in this domain
Type: int
Created By: User (optional)
Maximum number of security groups allowed in this domain
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * cpu_core_mask
Type: str
- Description:
- CPU Core Mask
Type: str
UIO Driver
Type: int
Hugepages Size
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * ipmi_address
Type: str
- Description:
- IPMI address of the server to manage boot device and power management
Type: str
UUID of the deploy initrd/ramdisk
Type: str
Password to access IPMI
Type: str
Remote IPMI RMCP port
Type: str
Username to access IPMI
Type: str
UUID of the deploy kernel
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * username
Type: str
- Description:
- username
Type: str
datacenter in vCenter
Type: str
ESXI host name(ip)
Type: str
cluster in vCenter
Type: str
mac address for contrailvm
Type: str
datastore in vCenter
Type: str
ESXI host password
Type: str
vCenter server
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * dvs_name
Type: str
- Description:
- Name of the Distributed Virtual Switch(DVS) assigned to Port.
Type: str
MOid of the Distributed Virtual Switch(DVS) assigned to Port.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * hashing_configured
Type: bool
Created By: User (optional)
- Description:
When True, Packet header fields used in calculating ECMP hash is decided by
following flags
Type: bool
Created By: User (optional)
When false, do not use source ip in the ECMP hash calculation
Type: bool
Created By: User (optional)
When false, do not use destination ip in the ECMP hash calculation
Type: bool
Created By: User (optional)
When false, do not use ip protocol in the ECMP hash calculation
Type: bool
Created By: User (optional)
When false, do not use source port in the ECMP hash calculation
Type: bool
Created By: User (optional)
When false, do not use destination port in the ECMP hash calculation
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * name
Type: str
Type: StatsCollectionFrequency
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * physical_health
Type: bool
Type: bool
Type: bool
Type: bool
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * encapsulation
Type: str, one-of [u’MPLSoGRE’, u’MPLSoUDP’, u’VXLAN’]
Created By: User (optional)
- Description:
- Ordered list of encapsulation types to be used in priority
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * tunnel_remote_ip_address
Type: str, one-of xsd:string
Created By: User (required)
- Description:
- Tunnel endpoint remote address
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * endpoint
Type: EncryptionTunnelEndpoint
- Description:
- Tunnel endpoint remote address
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * executable_info
Type: ExecutableInfoType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * executable_path
Type: str
Created By: User (required)
- Description:
- absolute path of the binary to execute
Type: str
Created By: User (optional)
Optional arguments to be passed to the executable
Type: int
Job percentage completion when this executable is completed.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * community
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * network_type
Type: str, one-of [u’management’, u’loopback’, u’ip-fabric’, u’pnf-servicechain’, u’overlay-loopback’]
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * enable
Type: bool
- Description:
- Enable/Disable knob for all Fast-Convergence parameters to take effect
Type: bool
Enable next-hop reachability checks in control plane for routes in underlay for
faster convergence
Type: int, within [1, 90]
The negotiated XMPP hold-time (in seconds) for sessions between the control and
data plane
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * fat_flow_protocol
Type: ProtocolType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * field_names
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * subnet
Type: str
Created By: User (optional)
Any workload that belongs to this virtual network
Type: str
Created By: User (optional)
Any workload with interface in this address-group
Type: str
Created By: User (optional)
Any workload with tags matching tags in this list
Type: int
Any workload with tags ids matching all the tags ids in this list
Type: bool
Created By: User (optional)
Match any workload
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * tag_list
Type: TagType
Created By: User (required)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * tag_type
Type: int
Created By: User (required)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * sequence
Type: str, one-of xsd:string
Created By: User (required)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * firewall_service
Type: FirewallServiceType
Created By: User (required)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * protocol
Type: str
- Description:
- Layer 4 protocol in ip packet
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * subnet_uuid
Type: str
- Description:
- List of subnets associated with this floating ip pool.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * protocol
Type: str
Type: int
Type: int
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * flow_aging_timeout
Type: FlowAgingTimeout
Created By: User (optional)
- Description:
- List of (ip protocol, port number, timeout in seconds)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * enable
Type: bool
- Description:
- Enable/Disable knob for all GR parameters to take effect
Type: int, within [0, 4095]
Time (in seconds) taken by the restarting speaker to get back to stable state
Type: int, within [0, 16777215]
Extended Time (in seconds) taken by the restarting speaker after restart-time to
get back to stable state
Type: int, within [0, 4095]
Maximum time (in seconds) to wait for EndOfRib reception/transmission
Type: bool
Enable GR Helper mode for BGP peers in contrail-control
Type: bool
Enable GR Helper mode for XMPP peers (agents) in contrail-control
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * allow_clients
Type: SubnetListType
Created By: User (required)
- Description:
- whitelist subnet of allowed clients on which various KPIs can be monitored.
Type: EnabledSensorParams
List of different top level sensor params that the user wishes to monitor using
telemetry. The user can include one or all of these for telemetry monitoring by
selecting specific options.
Type: str, one-of [u’cleartext’, u’ssl’]
Created By: User (optional)
secure (SSL) or cleartext mode of gRPC configuration.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * permissions
Type: UuidType
Created By: User (required)
UUID of the object, system automatically allocates one if not provided
Type: bool
Created By: User (required)
Administratively Enable/Disable this object
Type: xsd:dateTime
Time when this object was created
Type: xsd:dateTime
Time when this object was last modified
Type: str
Created By: User (optional)
User provided text
Type: bool
System created internal objects will have this flag set and will not be visible
Type: str
Id of tenant who created this object
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * import_export
Type: str, one-of [u’import’, u’export’]
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * port_info
Type: PortInfoType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * traffic_direction
Type: str, one-of [u’ingress’, u’egress’, u’both’]
Created By: User (required)
- Description:
- Specifies direction of traffic to mirror, Ingress, Egress or both
Type: MirrorActionType
Created By: User (required)
Mirror destination configuration
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * ip_address
Type: str, one-of xsd:string
- Description:
- String of standard notation of ipv4 or ipv6 address
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * tenant_dns_server_address
Type: IpAddressesType
Created By: User (optional)
- Description:
In case of tenant DNS server method, Ip address of DNS server. This will be
given in DHCP
Type: str
Created By: User (optional)
In case of virtual DNS server, name of virtual DNS server
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * subnet
Type: str, one-of xsd:string
Created By: User (optional)
default-gateway ip address in the subnet, if not provided one is auto generated
by the system.
Type: str, one-of xsd:string
Created By: User (optional)
DNS server ip address in the subnet, if not provided one is auto generated by
the system.
Type: str
Subnet UUID is auto generated by the system
Type: bool
Created By: User (optional)
Enable DHCP for the VM(s) in this subnet
Type: str
Created By: User (optional)
Tenant DNS servers ip address in tenant DNS method
Type: AllocationPoolType
Created By: User (optional)
List of ranges of ip address within the subnet from which to allocate ip
address. default is entire prefix
Type: bool
Created By: User (optional)
Start address allocation from start or from end of address range.
Type: DhcpOptionsListType
Created By: User (optional)
DHCP options list to be sent via DHCP for VM(s) in this subnet
Type: RouteTableType
Created By: User (optional)
Host routes to be sent via DHCP for VM(s) in this subnet, Next hop for these
routes is always default gateway
Type: str
Created By: User (optional)
User provided name for this subnet
Type: int
Created By: User (optional)
allocation unit for this subnet to allocate bulk ip addresses
Type: xsd:dateTime
Created By: User (optional)
timestamp when subnet object gets created
Type: xsd:dateTime
Created By: User (optional)
timestamp when subnet object gets updated
Type: str
Created By: User (optional)
This represents subscribers assigned ip addresses from this subnet for fabric
peer network
Type: int
Created By: User (optional)
vlan this subnet belongs to
Type: str, one-of xsd:string
Created By: User (optional)
DHCP relay server IP
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * subnets
Type: IpamSubnetType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * ipam_method
Type: str, one-of [u’dhcp’, u’fixed’]
Created By: User (optional)
Type: str, one-of [u’none’, u’default-dns-server’, u’tenant-dns-server’, u’virtual-dns-server’]
Created By: User (optional)
Type: IpamDnsAddressType
Created By: User (optional)
Type: DhcpOptionsListType
Created By: User (optional)
Type: SubnetType
Created By: User (optional)
Type: RouteTableType
Created By: User (optional)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * service_port
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * key
Type: str
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * key_value_pair
Type: KeyValuePair
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * lacp_enable
Type: bool
- Description:
- Enable or disable this option for configuring LACP related params
Type: str, one-of [u’fast’, u’slow’]
Timer interval for periodic transmission of LACP packets. Fast mode receives
packets every second. Slow mode receives packets every 30 seconds.
Type: str, one-of [u’active’, u’passive’]
Configure this mode to active to initiate transmission of LACP packets and
respond to LACP packets. LACP packets are not exchanged with passive mode.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * linklocal_service_name
Type: str
Created By: User (required)
- Description:
Name of the link local service. VM name resolution of this name will result in
link local ip address
Type: str, one-of xsd:string
Created By: User (required)
ip address of the link local service.
Type: int
Created By: User (required)
Destination TCP port number of link local service
Type: str
Created By: User (optional)
DNS name to which link local service will be proxied
Type: int
Created By: User (required)
Destination TCP port number to which link local traffic will forwarded
Type: str, one-of xsd:string
Created By: User (optional)
Destination ip address to which link local traffic will forwarded
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * linklocal_service_entry
Type: LinklocalServiceEntryType
Created By: User (optional)
- Description:
- List of link local services
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * admin_state
Type: bool
Created By: User (optional)
- Description:
- Administratively up or dowm.
Type: str, one-of [u’PING’, u’TCP’, u’HTTP’, u’HTTPS’]
Created By: User (required)
Protocol used to monitor health, PING, HTTP, HTTPS or TCP
Type: int
Created By: User (required)
Time in seconds at which health check is repeated
Type: int
Created By: User (required)
Time in seconds to wait for response
Type: int
Created By: User (required)
Number of failures before declaring health bad
Type: str
Created By: User (optional)
In case monitor protocol is HTTP, type of http method used like GET, PUT, POST
etc
Type: str
Created By: User (optional)
In case monitor protocol is HTTP, URL to be used. In case of ICMP, ip address
Type: str
Created By: User (optional)
In case monitor protocol is HTTP, expected return code for HTTP operations like
200 ok.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * protocol
Type: str, one-of [u’HTTP’, u’HTTPS’, u’TCP’, u’UDP’, u’TERMINATED_HTTPS’]
Type: int
Type: bool
Type: int
Type: str
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * admin_state
Type: bool
Created By: User (optional)
- Description:
- Administrative up or down.
Type: str
Operational status of the member.
Type: str
Operational status description of the member.
Type: int
Created By: User (optional)
Destination port for the application on the member.
Type: int
Created By: User (optional)
Weight for load balancing
Type: str, one-of xsd:string
Created By: User (optional)
Ip address of the member
Type: str, one-of xsd:string
Created By: User (optional)
UUID of the subnet from where the members are reachable.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * status
Type: str
- Description:
- Operating status for this loadbalancer pool.
Type: str
Operating status description for this loadbalancer pool.
Type: bool
Created By: User (optional)
Administrative up or down
Type: str, one-of [u’HTTP’, u’HTTPS’, u’TCP’, u’UDP’, u’TERMINATED_HTTPS’]
Created By: User (optional)
IP protocol string like http, https or tcp.
Type: str, one-of [u’ROUND_ROBIN’, u’LEAST_CONNECTIONS’, u’SOURCE_IP’]
Created By: User (optional)
Load balancing method ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP
Type: str, one-of xsd:string
Created By: User (optional)
UUID of the subnet from where the members of the pool are reachable.
Type: str, one-of [u’SOURCE_IP’, u’HTTP_COOKIE’, u’APP_COOKIE’]
Created By: User (optional)
Method for persistence. HTTP_COOKIE, SOURCE_IP or APP_COOKIE.
Type: str
Created By: User (optional)
To Be Added
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * status
Type: str
Created By: User (optional)
- Description:
- Operational status of the load balancer updated by system.
Type: str
Created By: User (optional)
Provisioning status of the load balancer updated by system.
Type: str
Created By: User (optional)
Operational status of the load balancer updated by system.
Type: str, one-of xsd:string
Created By: User (optional)
Subnet UUID of the subnet of VIP, representing virtual network.
Type: str, one-of xsd:string
Created By: User (optional)
Virtual ip for this LBaaS
Type: bool
Created By: User (optional)
Administrative up or down
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * switch_info
Type: str
- Description:
- UUID of the Physical-Port with contrail database
Type: str
Port-Id provided by LLDP, This usually maps to SnmpIndex
Type: str
Port ID of switch where Baremetal is connected
Type: str
Switch hostname
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * logical_router_uuid
Type: str
Created By: User (required)
- Description:
- stores destination logical router uuid for dci intra-fabric type.
Type: str
Created By: User (required)
list of physical routers uuid exists in current destination logical-router and
user has selected this PR for dci intra-fabric route leaks.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * logical_router_list
Type: LogicalRouterPRListParams
- Description:
- List of Destination LRs properties
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * logical_router_virtual_network_type
Type: str, one-of [u’ExternalGateway’, u’InternalVirtualNetwork’, u’NAPTSourcePool’]
Created By: User (optional)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * mac_limit
Type: int
Created By: User (required)
- Description:
- Number of MACs that can be learnt
Type: str, one-of [u’log’, u’alarm’, u’shutdown’, u’drop’]
Created By: User (optional)
Action to be taken when MAC limit exceeds
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * mac_move_limit
Type: int
Created By: User (required)
- Description:
- Number of MAC moves permitted in mac move time window
Type: int, within [1, 60]
Created By: User (required)
MAC move time window
Type: str, one-of [u’log’, u’alarm’, u’shutdown’, u’drop’]
Created By: User (optional)
Action to be taken when MAC move limit exceeds
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * mac_address
Type: None
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * protocol
Type: str
Created By: User (required)
- Description:
- Layer 4 protocol in ip packet
Type: AddressType
Created By: User (required)
Source ip matching criteria
Type: PortType
Created By: User (required)
Range of source port for layer 4 protocol
Type: AddressType
Created By: User (required)
Destination ip matching criteria
Type: PortType
Created By: User (required)
Range of destination port for layer 4 protocol
Type: str, one-of [u’IPv4’, u’IPv6’]
Created By: User (required)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * analyzer_name
Type: str
Created By: User (optional)
- Description:
- Name of service instance used as analyzer
Type: str
Created By: User (optional)
Encapsulation for Mirrored packet, not used currently
Type: str, one-of xsd:string
Created By: User (required)
ip address of interface to which mirrored packets are sent
Type: str
Created By: User (optional)
mac address of interface to which mirrored packets are sent
Type: str
Created By: User (required)
Routing instance for the virtual network which analyzer is in
Type: int
Created By: User (optional)
ip udp port used in contrail default encapsulation for mirroring
Type: bool
Created By: User (optional)
This flag is used to determine with/without juniper-header
Type: str, one-of [u’dynamic’, u’static’]
Created By: User (optional)
This mode used to determine static or dynamic nh
Type: StaticMirrorNhType
Created By: User (optional)
vtep details required if static nh enabled
Type: bool
Created By: User (optional)
This flag is used to select nic assisted mirroring
Type: int, within [0, 4094]
Created By: User (optional)
The VLAN to be tagged on the traffic for NIC to Mirror
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * source_address
Type: str, one-of xsd:string
Created By: User (required)
- Description:
- Multicast Source Address
Type: str, one-of xsd:string
Created By: User (required)
Multicast Group Address
Type: str, one-of [u’deny’, u’pass’]
Created By: User (required)
Pass or deny action for (S,G) matching this rule
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * multicast_source_group
Type: MulticastSourceGroup
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * ipv4_cidr
Type: AutonomousSystemsType
Created By: User (optional)
Namespace as Autonomous System Numbers
Type: MacAddressesType
Created By: User (optional)
Namespace as MAC addresses
Type: AsnRangeType
Created By: User (optional)
Namespace as ASN ranges
Type: str
Created By: User (optional)
Namespace as MAC addresses
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * enabled_sensor_params
Type: EnabledSensorParams
- Description:
List of different top level sensor params that the user wishes to monitor using
telemetry. The user can include one or all of these for telemetry monitoring by
selecting specific options.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * physical_role
Type: str
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * role_mappings
Type: NodeProfileRoleType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * auth_data
Type: AuthenticationData
Created By: User (optional)
- Description:
- Authentication related configuration like type, keys etc.
Type: int
Created By: User (optional)
Specifies the length of time, in seconds, before the routing device sends a
hello packet out of an interface.
Type: int
Created By: User (optional)
Specifies how long OSPF waits before declaring that a neighboring routing device
is unavailable
Type: str, one-of xsd:string
Created By: User (required)
OSPF area ID
Type: str, one-of [u’nssa’, u’stub’, u’backbone’]
Created By: User (required)
OSPF area type
Type: bool
Created By: User (optional)
Boolean to enable advertising loopback address.
Type: bool
Created By: User (optional)
Boolean to enable originating summary LSA.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * owner
Type: str
Type: int, within [0, 7]
Three bits representing rwx.
r=read permission,
w=write permission,
x=reference permission
Type: str
Type: int, within [0, 7]
Three bits representing rwx.
r=read permission,
w=write permission,
x=reference permission
Type: int, within [0, 7]
Three bits representing rwx.
r=read permission,
w=write permission,
x=reference permission
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * owner
Type: str
Created By: User (required)
- Description:
- Owner tenant of the object
Type: int, within [0, 7]
Created By: User (required)
Owner permissions of the object
Type: int, within [0, 7]
Created By: User (optional)
Globally(others) shared object and permissions for others of the object
Type: ShareType
Created By: User (optional)
Selectively shared object, List of (tenant, permissions)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * rp_ip_address
Type: str, one-of xsd:string
Created By: User (required)
- Description:
- Static rendezvous point IP address.
Type: str, one-of [u’sparse’, u’sparse-dense’, u’dense’]
Created By: User (optional)
Pim mode.
Type: bool
Created By: User (optional)
Boolean to enable PIM on all interfaces.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * playbook_info
Type: PlaybookInfoType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * playbook_uri
Type: str
Created By: User (required)
- Description:
- uri to the playbook location on the file server
Type: bool
if set to true, the execute-job action url uses the job-template parameter
‘device-list’ to execute the playbook in parallel
Type: str
Created By: User (optional)
Vendor name
Type: str
Created By: User (optional)
Device family name
Type: int
Job percentage completion when this playbook is completed. This attribute value
should 100 if there is only one playbook defined in the job template. The job-
completion-weigtages for all playbooks in the same job-template should add up to
100 exact.
Type: int
Created By: User (optional)
Sequence number of the playbook
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * plugin_property
Type: PluginProperty
Created By: User (optional)
- Description:
- List of plugin specific properties (property, value)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * property
Type: str
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * direction
Type: str, one-of [u’ingress’, u’egress’, u’both’]
Type: int
Type: str
Type: str
Type: int
Type: str, one-of xsd:string
Type: str, one-of xsd:string
String of standard notation of ipv4 or ipv6 address
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * policy_rule
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * rule_sequence
Type: SequenceType
Created By: User (optional)
- Description:
- Deprecated, Will be removed because rules themselves are already an ordered list
Type: str
Created By: User (optional)
Rule UUID is identifier used in flow records to identify rule
Type: str, one-of [u’>’, u’<>’]
Created By: User (required)
Type: str
Created By: User (required)
Layer 4 protocol in ip packet
Type: AddressType
Created By: User (required)
Source ip matching criteria
Type: PortType
Created By: User (required)
Range of source port for layer 4 protocol
Type: str
Created By: User (optional)
Optionally application can be specified instead of protocol and port. not
currently implemented
Type: AddressType
Created By: User (required)
Destination ip matching criteria
Type: PortType
Created By: User (required)
Range of destination port for layer 4 protocol
Type: ActionListType
Created By: User (required)
Actions to be performed if packets match condition
Type: str, one-of [u’IPv4’, u’IPv6’]
Created By: User (required)
Type: xsd:dateTime
Created By: User (optional)
timestamp when security group rule object gets created
Type: xsd:dateTime
Created By: User (optional)
timestamp when security group rule object gets updated
Type: str
Created By: User (optional)
User provided text
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * term
Type: PolicyTermType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * term_match_condition
Type: TermMatchConditionType
Type: TermActionListType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * miimon
Type: int
- Description:
- Specifies the MII link monitoring frequency in milliseconds.
Type: str
Transmit hash policy to use for slave selection in balance-xor, 802.3ad, and tlb
modes.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * name
Type: str
Type: str, one-of [u’fc’, u’ge’, u’xe’, u’xle’, u’et’, u’fte’, u’me’, u’em’]
Type: str, one-of [u‘1G’, u‘10G’, u‘40G’, u‘100G’]
Type: bool
Type: str, one-of [u‘1G’, u‘10G’, u‘40G’, u‘100G’]
Type: str
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * protocol
Type: str
Type: int
Type: int
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * port_mappings
Type: PortMap
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * port_disable
Type: bool
Type: int, within [256, 9216]
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * port_params
Type: PortParameters
- Description:
User can select this option to configure port parameters such as description,
MTU and port enable or disable.
Type: bool
User can enable this option to configure flow control.
Type: LacpParams
Represents LACP configuration parameters.
Type: bool
User can enable this option to prevent loops on edge interfaces. This is applied
on unit with family ethernet-switching.
Type: bool
Enabling this option causes an interface to be not trusted. Untrusting an
interface is achieved by applying 802.1 IP untrust classifier configuration.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * protocol
Type: str
Type: PortType
Created By: User (optional)
Port range to be reserved for per layer 4 protocol for PAT
Type: unsignedShort
Created By: User (optional)
Number of ports per layer 4 protocol to be reserved for PAT
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * port_translation_pool
Type: PortTranslationPool
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * start_port
Type: int, within [-1, 65535]
Created By: User (required)
Type: int, within [-1, 65535]
Created By: User (required)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * interface_route_table_uuid
Type: str
Created By: User (required)
- Description:
- list of interface route table uuids used to build list of prefixes.
Type: str, one-of [u’exact’, u’longer’, u’orlonger’]
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * prefix
Type: str
Type: str, one-of [u’exact’, u’longer’, u’orlonger’]
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * autonomous_system
Type: int
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * area
Type: int
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * route
Type: IpPrefixType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * protocol
Type: str
Type: int
Type: str, one-of [u’none’, u’source’, u’destination’]
Created By: User (optional)
Address ignored while creating flows, from the perspective of packets egressing
the VM. For packets originated by VM, source and destination indicate the
corresponding IPs in the packet. For packets coming from remote source, source
indicates destination IP of the packet is ignored and destination indicates
source IP of the packet is ignored.
Type: SubnetType
Created By: User (optional)
For packets originated from VM source-prefix is applied to source IP of the
packet. For packets coming to VM, source-prefix is applied to destination IP of
the packet
Type: int
Created By: User (optional)
Fat flow prefix mask length for IP where source-prefix is applied
Type: SubnetType
Created By: User (optional)
For packets originated from VM destination-prefix is applied to destination IP
of the packet. For packets coming to VM, destination-prefix is applied to source
IP of the packet
Type: int
Created By: User (optional)
Fat flow prefix mask length for IP where destination-prefix is applied
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * segmentation_id
Type: int, within [0, 4094]
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * key
Type: int
- Description:
- QoS bit value (DSCP or Vlan priority or EXP bit value
Type: int, within [0, 255]
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * qos_id_forwarding_class_pair
Type: QosIdForwardingClassPair
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * defaults
Type: int
Created By: User (optional)
- Description:
- Need to clarify
Type: int
Created By: User (optional)
Maximum number of floating ips
Type: int
Created By: User (optional)
Maximum number of instance ips
Type: int
Created By: User (optional)
Maximum number of virtual machine interfaces
Type: int
Created By: User (optional)
Maximum number of virtual networks
Type: int
Created By: User (optional)
Maximum number of logical routers
Type: int
Created By: User (optional)
Maximum number of virtual DNS servers
Type: int
Created By: User (optional)
Maximum number of virtual DNS records
Type: int
Created By: User (optional)
Maximum number of bgp routers
Type: int
Created By: User (optional)
Maximum number of network IPAMs
Type: int
Created By: User (optional)
Maximum number of access control lists
Type: int
Created By: User (optional)
Maximum number of network policies
Type: int
Created By: User (optional)
Maximum number of floating ip pools
Type: int
Created By: User (optional)
Maximum number of service templates
Type: int
Created By: User (optional)
Maximum number of service instances
Type: int
Created By: User (optional)
Maximum number of logical routers
Type: int
Created By: User (optional)
Maximum number of security groups
Type: int
Created By: User (optional)
Maximum number of security group rules
Type: int
Created By: User (optional)
Maximum number of subnets
Type: int
Created By: User (optional)
Maximum number of global vrouter configs
Type: int
Created By: User (optional)
Maximum number of loadbalancers
Type: int
Created By: User (optional)
Maximum number of loadbalancer listeners
Type: int
Created By: User (optional)
Maximum number of loadbalancer pools
Type: int
Created By: User (optional)
Maximum number of loadbalancer member
Type: int
Created By: User (optional)
Maximum number of loadbalancer health monitors
Type: int
Created By: User (optional)
Maximum number of virtual ips
Type: int
Created By: User (optional)
Maximum number of security logging objects
Type: int
Created By: User (optional)
Maximum number of route tables
Type: int
Created By: User (optional)
Maximum number of application policy set
Type: int
Created By: User (optional)
Maximum number of firewall policy
Type: int
Created By: User (optional)
Maximum number of firewall rule
Type: int, within [0, 1]
Created By: User (optional)
Maximum number of host based service. Actually limited to 0 or 1 for a project
(can not be unlimited or more than 1)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * role_name
Type: str
Created By: User (required)
- Description:
- Name of the role
Type: str
Created By: User (required)
String CRUD representing permissions for C=create, R=read, U=update, D=delete.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * rbac_rule
Type: RbacRuleType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * rule_object
Type: str
Created By: User (required)
- Description:
- Name of the REST API (object) for this rule, * represent all objects
Type: str
Created By: User (optional)
Name of the level one field (property) for this object, * represent all
properties
Type: RbacPermType
Created By: User (required)
List of [(role, permissions),...]
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * route
Type: str
Created By: User (required)
- Description:
- route filter IP address or host name.
Type: str, one-of [u’exact’, u’longer’, u’orlonger’, u’prefix-length-range’, u’through’, u’upto’]
Type: str
Created By: User (optional)
Valid only for through, upto or prefix-length-range RouteFType. Format: for
prefix-length-range it stores ‘/min-length-/max-length’. through should be
string, upto stores ‘/number’
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * route_filter_properties
Type: RouteFilterProperties
- Description:
- List of route filter properties.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * route
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * origin_override
Type: bool
Created By: User (optional)
- Description:
- Set true to override Route origin with the given value
Type: str, one-of [u’IGP’, u’EGP’, u’INCOMPLETE’]
Created By: User (optional)
User define route origin value
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * route
Type: RouteType
- Description:
- List of ip routes with following fields.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * route_target
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * prefix
Type: str
- Description:
- Ip prefix/len format prefix
Type: str
Ip address or service instance name.
Type: str, one-of [u’service-instance’, u’ip-address’]
Type: CommunityAttributes
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * physical_router_uuid
Type: str
Created By: User (required)
- Description:
- Routed properties for particular physical router for this virtual-network.
Type: str
Created By: User (required)
Routed properties for particular logical router for this virtual-network.
Type: str, one-of xsd:string
Created By: User (required)
IP address of the routed interface from the VN subnet.
Type: str, one-of xsd:string
Created By: User (optional)
IP address of the loopback interface from the overlay loopback subnet.
Type: str, one-of [u’static-routes’, u’bgp’, u’ospf’, u’pim’]
Created By: User (required)
Protocol used for exchanging route information.
Type: BgpParameters
Created By: User (optional)
BGP parameters such as ASN, peer IP address, authentication method/key.
Type: OspfParameters
Created By: User (optional)
OSPF parameters such as area ID, area type, hello-interval, dead-interval,
authentication method/key.
Type: PimParameters
Created By: User (optional)
PIM parameters such as RP IP address, mode.
Type: StaticRouteParameters
Created By: User (optional)
Static route parameters such as interface route table uuid, next hop IP address.
Type: BfdParameters
Created By: User (optional)
BFD parameters such as time interval, detection time multiplier.
Type: RoutingPolicyParameters
Created By: User (optional)
List of import/export routing policy uuids.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * rb_roles
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * import_routing_policy_uuid
Type: str
Created By: User (optional)
- Description:
- list of routing policy uuids used as import policies.
Type: str
Created By: User (optional)
list of routing policy uuids used as export policies.
Bases: gen.generatedssuper.GeneratedsSuper
A given routing policy could be attached to both left or right interface of a
service instance. If it is the case, set both the left-sequence and right-
sequence. If you only want to attach it to either left or right, but not both,
then only set the corresponding sequence number. A value of None also means it
is not attached to that interface.
Attributes: * left_sequence
Type: str, one-of xsd:string
Type: str, one-of xsd:string
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * sequence
Type: str, one-of xsd:string
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * version
Type: int
Type: int
Type: int
Type: int
Type: str
Type: str
Type: str
Type: str
Type: str
Type: str
Type: str
Type: str
Type: str
Type: str
Type: str
Type: int
Type: int
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * rule_uuid
Type: str
Created By: User (optional)
- Description:
Rule UUID of network policy or security-group. When this is absent it implies
all rules of security-group or network-policy
Type: int
Created By: User (optional)
Rate at which sessions are logged. When rates are specified at multiple levels,
the rate which specifies highest frequency is selected
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * rule
Type: SecurityLoggingObjectRuleEntryType
Created By: User (optional)
- Description:
List of rules along with logging rate for each rule. Both rule-uuid and rate are
optional. When rule-uuid is absent then it means all rules of associated SG or
network-policy
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * major
Type: int
Created By: User (required)
Type: int
Created By: User (required)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * serial_num
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * interface_type
Type: str, one-of xsd:string
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * routing_instance
Type: str
Type: str
Type: str, one-of xsd:string
Type: str
Type: str
Type: str
Type: bool
Type: bool
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * enabled
Type: bool
Created By: User (optional)
- Description:
- Administratively enable or disable this health check.
Type: str, one-of [u’link-local’, u’end-to-end’, u’segment’, u’vn-ip-list’]
Created By: User (required)
Health check type, currently only link-local, end-to-end and segment are
supported
Type: str, one-of [u’PING’, u’HTTP’, u’BFD’]
Created By: User (required)
Protocol used to monitor health, currently only HTTP, ICMP(ping), and BFD are
supported
Type: int
Created By: User (required)
Time in seconds at which health check is repeated
Type: int
Created By: User (optional)
Time in micro seconds at which health check is repeated
Type: int
Created By: User (required)
Time in seconds to wait for response
Type: int
Created By: User (optional)
Time in micro seconds to wait for response
Type: int
Created By: User (required)
Number of failures before declaring health bad
Type: str
Created By: User (optional)
In case monitor protocol is HTTP, type of http method used like GET, PUT, POST
etc
Type: str
Created By: User (optional)
In case monitor protocol is HTTP, URL to be used. In case of ICMP, ip address
Type: str
Created By: User (optional)
In case monitor protocol is HTTP, expected return code for HTTP operations like
200 ok.
Type: bool
Created By: User (optional)
Run BFD for all IP Addresses learnt by mac-ip learning, when enabled.
Type: IpAddressesType
Created By: User (optional)
Any address that belongs to the list has to run BFD health check when target-ip-
all is false.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * virtual_network
Type: str
Created By: User (required)
- Description:
- Interface belongs to this virtual network.
Type: str, one-of xsd:string
Created By: User (optional)
Shared ip for this interface (Only V1)
Type: RouteTableType
Created By: User (optional)
Static routes for this interface (Only V1)
Type: AllowedAddressPairs
Created By: User (optional)
Allowed address pairs, list of (IP address, MAC) for this interface
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * auto_policy
Type: bool
- Description:
Set when system creates internal service chains, example SNAT with router
external flag in logical router
Type: str
Created By: User (optional)
Availability zone used to spawn VM(s) for this service instance, used in version
1 (V1) only
Type: str
Created By: User (optional)
Deprecated
Type: str
Created By: User (optional)
Deprecated
Type: str, one-of xsd:string
Created By: User (optional)
Deprecated
Type: str
Created By: User (optional)
Deprecated
Type: str, one-of xsd:string
Created By: User (optional)
Deprecated
Type: ServiceInstanceInterfaceType
Created By: User (required)
List of service instance interface properties. Ordered list as per service
template
Type: ServiceScaleOutType
Created By: User (optional)
Number of virtual machines in this service instance, used in version 1 (V1) only
Type: str, one-of [u’active-active’, u’active-standby’]
Created By: User (optional)
When scale-out is greater than one, decides if active-active or active-backup,
used in version 1 (V1) only
Type: str
Created By: User (optional)
UUID of a virtual-router on which this service instance need to spawn. Used to
spawn services on CPE device when Nova is not present
Type: str, one-of [u’virtual-machine’, u’network-namespace’, u’vrouter-instance’, u’physical-device’]
Created By: User (optional)
Service virtualization type decides how individual service instances are
instantiated
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * interface_type
Type: str, one-of xsd:string
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * retain_as_path
Type: bool
Created By: User (optional)
- Description:
Indicates if as-path should be retained across service-instances in the service-
chain
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * max_instances
Type: int
Created By: User (required)
- Description:
- Maximum number of scale out factor(virtual machines). can be changed dynamically
Type: bool
Created By: User (required)
Automatically change the number of virtual machines. Not implemented
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * service_interface_type
Type: str, one-of xsd:string
Created By: User (required)
- Description:
- Type of service interface supported by this template left, right or other.
Type: bool
Created By: User (optional)
Shared ip is required on this interface when service instance is scaled out
(Only V1)
Type: bool
Created By: User (optional)
Static routes configured required on this interface of service instance (Only
V1)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * version
Type: int
Created By: User (optional)
- Description:
Version of service template.
1: Service virtual machines and interfaces are automatically launched,monitored and deleted.
2: User creates all objects( virtual machines and interfaces) and managesthe life cycle.
Useful when virtual machines and interfaces are managed via heat template
Type: str, one-of [u’transparent’, u’in-network’, u’in-network-nat’]
Created By: User (required)
Service instance mode decides how packets are forwarded across the service
Type: str, one-of [u’firewall’, u’analyzer’, u’source-nat’, u’loadbalancer’]
Created By: User (required)
Service instance mode decides how routing happens across the service
Type: str
Created By: User (optional)
Glance image name for the service virtual machine, Version 1 only
Type: bool
Created By: User (optional)
Enable scaling of service virtual machines, Version 1 only
Type: ServiceTemplateInterfaceType
Created By: User (required)
List of interfaces which decided number of interfaces and type
Type: str
Created By: User (optional)
Nova flavor used for service virtual machines, Version 1 only
Type: bool
Created By: User (optional)
Deprecated
Type: str, one-of [u’virtual-machine’, u’network-namespace’, u’vrouter-instance’, u’physical-device’]
Created By: User (optional)
Service virtualization type decides how individual service instances are
instantiated
Type: bool
Created By: User (optional)
Enable availability zone for version 1 service instances
Type: str, one-of [u’libvirt-qemu’, u’docker’]
Created By: User (optional)
Mechanism used to spawn service instance, when vrouter is spawning
instances.Allowed values libvirt-qemu, docker or netns
Type: str
Created By: User (optional)
Opaque string (typically in json format) used to spawn a vrouter-instance.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * virtual_network_type
Type: str, one-of xsd:string
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * stats_collection_frequency
Type: StatsCollectionFrequency
- Description:
Represents polling interval and sample rate either at the global level or at per
interface level. Polling interval is specified in seconds that the device waits
between port statistics update messages. Sample rate is specified as a number
(one packet out of number).
Type: str, one-of xsd:string
IP address to be assigned as the agent ID for the sFlow agent.
Type: int, within [300, 900]
Created By: User (optional)
Represents maximum number of samples that should be generated per line card.
Type: str, one-of [u’all’, u’fabric’, u’service’, u’access’, u’custom’]
User can enable sflow either on all interfaces or all fabric ports or all access
ports or custom list of interfaces.
Type: EnabledInterfaceParams
If interface type is set to custom, this represents the list of physical
interfaces to be enabled for sflow. User can specify polling interval and sample
rate for each interface in this custom list.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * tenant
Type: str
Created By: User (required)
- Description:
- Name of tenant with whom the object is shared
Type: int, within [0, 7]
Created By: User (required)
Allowed permissions in sharing
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * rate
Type: int
- Description:
- Rate at which sessions are logged
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * enabled_sensor_params
Type: EnabledSensorParams
- Description:
List of different top level sensor params that the user wishes to monitor using
telemetry. The user can include one or all of these for telemetry monitoring by
selecting specific options.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * sriov_physical_interface
Type: str
- Description:
- SRIOV Physical Interface
Type: int
SRIOV Virtual Function
Type: str
SRIOV Physical Network
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * vtep_dst_ip_address
Type: str, one-of xsd:string
Created By: User (required)
- Description:
- ip address of destination vtep
Type: str
Created By: User (optional)
mac address of destination vtep
Type: int, within [1, 16777215]
Created By: User (required)
Vni of vtep
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * route
Type: StaticRouteType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * interface_route_table_uuid
Type: str
Created By: User (required)
- Description:
- list of interface route table uuids used to build list of prefixes.
Type: str, one-of xsd:string
Created By: User (required)
List of next-hop IP addresses.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * prefix
Type: str
Type: str
Type: str
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * sample_rate
Type: int, within [1, 16777215]
Created By: User (optional)
Type: int, within [0, 3600]
Created By: User (optional)
Type: str, one-of [u’ingress’, u’egress’]
Created By: User (optional)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * storm_control_actions
Type: str, one-of [u’interface-shutdown’]
- Description:
Default action (Discard) is implicit. In addition, other list of actions can be
specified here
Type: int
Created By: User (optional)
Timeout in seconds. This enables the affected interface to recover automatically
from the error condition after the specified period of time
Type: bool
if set to true, disable unregistered multicast traffic storm control
Type: bool
if set to true, disable registered multicast traffic storm control
Type: bool
if set to true, disable unknown unicast traffic storm control
Type: bool
if set to true, disable muticast traffic storm control
Type: bool
if set to true, disable broadcast traffic storm control
Type: int
Created By: User (required)
Configure storm control bandwidth level as percentage
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * dscpListIPv4
Type: StructuredSyslogDSCPType
Type: StructuredSyslogDSCPType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * dscp_value
Type: str
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * LANSegmentList
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * vpn
Type: str
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * overlay
Type: str
Type: str
Type: str
Type: str
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * links
Type: StructuredSyslogLinkType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * subnet
Type: SubnetType
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * ip_prefix
Type: str
Type: int
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * name
Type: str
Type: str
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * resource
Type: TelemetryResourceInfo
Type: str
Type: int
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * update
Type: ActionUpdateType
Type: str, one-of [u’reject’, u’accept’, u’next’]
Type: str, one-of [u’term’, u’policy’]
Created By: User (optional)
Type: str, one-of [u’ospf-type-1’, u’ospf-type-2’]
Created By: User (optional)
Type: str
Created By: User (optional)
Valid only for network-device TermType. string should be in format of AS
number(s) seperated by spaces
Type: str
Created By: User (optional)
Valid only for network-device TermType. string should be in format of AS
number(s) seperated by spaces
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * protocol
Type: str, one-of [u’xmpp’, u’service-chain’, u’interface’, u’interface-static’, u’service-interface’, u’bgpaas’, u’bgp’, u’static’, u’aggregate’, u’direct’, u’pim’, u’evpn’, u’ospf’, u’ospf3’]
Type: PrefixMatchType
Type: str
Type: str
Type: bool
Type: str
Type: bool
Type: str, one-of [u’inet’, u’inet-vpn’, u’evpn’]
Created By: User (optional)
Type: int
Created By: User (optional)
Type: str, one-of [u’ospf-type-1’, u’ospf-type-2’]
Created By: User (optional)
Type: int
Created By: User (optional)
Type: int
Created By: User (optional)
list of integer values in range of 1 to 10 inclusive.
Type: PrefixListMatchType
Created By: User (optional)
list of prefixes from interface route table uuids with prefix types.
Type: RouteFilterType
Created By: User (optional)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * start_time
Type: xsd:dateTime
Created By: User (required)
Type: str
Created By: User (required)
Type: str
Created By: User (required)
Type: xsd:dateTime
Created By: User (required)
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * username
Type: str
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * name
Type: str
Created By: User (required)
- Description:
- Name of the stat
Type: str
Created By: User (required)
Perl type regular expression pattern to match
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * statlist
Type: UserDefinedLogStat
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * uuid_mslong
Type: int
Type: int
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * uve_key
Type: str
Created By: User (required)
- Description:
- List of UVE tables where this alarm config should be applied
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * vlan_tag
Type: int, within [0, 4094]
Created By: User (optional)
- Description:
- Tagged VLAN
Type: int, within [0, 4094]
Created By: User (optional)
Untagged VLAN
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * vendor_hardware
Type: str
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * record_name
Type: str
Created By: User (required)
- Description:
- DNS name to be resolved
Type: str, one-of [u’A’, u’AAAA’, u’CNAME’, u’PTR’, u’NS’, u’MX’]
Created By: User (optional)
DNS record type can be A, AAAA, CNAME, PTR, NS and MX
Type: str, one-of [u’IN’]
Created By: User (optional)
DNS record class supported is IN
Type: str
Created By: User (required)
DNS record data is either ip address or string depending on type
Type: int
Created By: User (optional)
Time To Live for this DNS record
Type: int
Created By: User (optional)
Type: str
name of the compute node which sends add for A type or PTR type dns record for
vm
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * domain_name
Type: str
Created By: User (required)
- Description:
- Default domain name for this virtual DNS server
Type: bool
Created By: User (optional)
Allow automatic addition of records on VM launch, default is True
Type: str, one-of [u’fixed’, u’random’, u’round-robin’]
Created By: User (optional)
Order of DNS load balancing, fixed, random, round-robin. Default is random
Type: int
Created By: User (optional)
Default Time To Live for DNS records
Type: str
Created By: User (optional)
Next virtual DNS server to lookup if record is not found. Default is proxy to
infrastructure DNS
Type: str, one-of [u’dashed-ip’, u’dashed-ip-tenant-name’, u’vm-name’, u’vm-name-tenant-name’]
Created By: User (optional)
Decides how floating ip records are added
Type: bool
Created By: User (optional)
Currently this option is not supported
Type: bool
Created By: User (optional)
Allow reverse DNS resolution, ip to name mapping
Type: DnsSoaRecordType
Created By: User (optional)
Dns soa record values
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * address
Type: str, one-of xsd:string
- Description:
- IP address automatically allocated by system.
Type: str
Operating status for this virtual ip.
Type: str
Operating status description this virtual ip.
Type: bool
Created By: User (optional)
Administrative up or down.
Type: str, one-of [u’HTTP’, u’HTTPS’, u’TCP’, u’UDP’, u’TERMINATED_HTTPS’]
Created By: User (optional)
IP protocol string like http, https or tcp.
Type: int
Created By: User (optional)
Layer 4 protocol destination port.
Type: int
Created By: User (optional)
Maximum number of concurrent connections
Type: str, one-of xsd:string
Created By: User (optional)
UUID of subnet in which to allocate the Virtual IP.
Type: str
Created By: User (optional)
Set this string if the relation of client and server(pool member) need to
persist.
Type: str, one-of [u’SOURCE_IP’, u’HTTP_COOKIE’, u’APP_COOKIE’]
Created By: User (optional)
Method for persistence. HTTP_COOKIE, SOURCE_IP or APP_COOKIE.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * service_interface_type
Type: str, one-of xsd:string
Created By: User (optional)
- Description:
- This interface belongs to Service Instance and is tagged as left, right or other
Type: InterfaceMirrorType
Created By: User (optional)
Interface Mirror configuration
Type: int
Created By: User (optional)
BGP route local preference for routes representing this interface, higher value
is higher preference
Type: int
Created By: User (optional)
802.1Q VLAN tag to be used if this interface is sub-interface for some other
interface.
Type: int, within [0, 4294967296]
Created By: User (optional)
Maximum number of flows permitted on VMI
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * sequence
Type: SequenceType
Created By: User (optional)
- Description:
- Sequence number to specify order of policy attachment to network
Type: TimerType
Created By: User (optional)
Timer to specify when the policy can be active
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * routed_properties
Type: RoutedProperties
- Description:
- List of routed properties for virtual network.
Type: bool
Created By: User (optional)
Allow sharing of this routed virtual network across all LR’s in the system.
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * allow_transit
Type: bool
Created By: User (optional)
- Description:
Enables transitive property for route imports.
If B imports routes of A and C imports from B,
then if B is transitive then C will have routes from A.
Type: int
Not currently in used
Type: int, within [1, 16777215]
Created By: User (required)
VxLAN VNI value for this network
Type: str, one-of [u’l2_l3’, u’l2’, u’l3’]
Created By: User (optional)
Packet forwarding mode for this virtual network
Type: str, one-of [u’enable’, u’disable’]
Created By: User (optional)
Flag used to disable Reverse Path Forwarding(RPF) check for this network
Type: bool
Created By: User (optional)
Flag to mark the virtual network as mirror destination network
Type: int, within [0, 4294967296]
Created By: User (optional)
Maximum number of flows permitted on each VMI of the VN
Type: int, within [0, 9216]
Created By: User (optional)
MTU value for this network
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * allocation_pools
Type: AllocationPoolType
Created By: User (optional)
- Description:
- List of ranges of ip address for vrouter specific allocation
Type: SubnetType
Created By: User (optional)
List of ip prefix and length for vrouter specific subnets
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * ipam_subnets
Type: IpamSubnetType
Type: RouteTableType
Created By: User (optional)
Common host routes to be sent via DHCP for VM(s) in all the subnets, Next hop
for these routes is always default gateway
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * ae_num
Type: int
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * match_condition
Type: MatchConditionType
Type: int
Type: str
Type: bool
Bases: gen.generatedssuper.GeneratedsSuper
Attributes: * vrf_assign_rule
Type: VrfAssignRuleType
