Library API reference

resource_common Module

resource_xsd Module

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

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * dynamic

Type: bool

Created By: User (optional)

Description:
For Internal use only
  • acl_rule

    Type: AclRuleType

    Created By: User (required)

    Description:

    For Internal use only

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * match_condition

Type: MatchConditionType

Created By: User (required)

Description:
Match condition for packets
  • action_list

    Type: ActionListType

    Created By: User (required)

    Description:

    Actions to be performed if packets match condition

  • rule_uuid

    Type: str

    Created By: User (optional)

    Description:

    Rule UUID is identifier used in flow records to identify rule

  • direction

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

    Created By: User (optional)

    Description:

    Direction in the rule

class gen.resource_xsd.ActionAsPathType(expand=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * expand

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * add

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * add

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * simple_action

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

Created By: User (required)

Description:
Simple allow(pass) or deny action for traffic matching this rule
  • gateway_name

    Type: str

    Created By: User (optional)

    Description:

    For internal use only

  • apply_service

    Type: str

    Created By: User (optional)

    Description:

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

    the rule

  • mirror_to

    Type: MirrorActionType

    Created By: User (optional)

    Description:

    Mirror traffic matching this rule

  • assign_routing_instance

    Type: str

    Created By: User (optional)

    Description:

    For internal use only

  • log

    Type: bool

    Created By: User (optional)

    Description:

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

  • alert

    Type: bool

    Created By: User (optional)

    Description:

    For internal use only

  • qos_action

    Type: str

    Created By: User (optional)

    Description:

    FQN of Qos configuration object for QoS marking

  • host_based_service

    Type: bool

    Description:

    Forward traffic matching this rule to the project’s host based service

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * as_path

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * family

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

Description:
BGP address families supported by contrail.
class gen.resource_xsd.AddressType(subnet=None, virtual_network=None, security_group=None, network_policy=None, subnet_list=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * subnet

Type: SubnetType

Created By: User (optional)

Description:
Any address that belongs to this subnet
  • virtual_network

    Type: str

    Created By: User (optional)

    Description:

    Any address that belongs to this virtual network

  • security_group

    Type: str

    Created By: User (optional)

    Description:

    Any address that belongs to interface with this security-group

  • network_policy

    Type: str

    Created By: User (optional)

    Description:

    Any address that belongs to virtual network which has this policy attached

  • subnet_list

    Type: SubnetType

    Created By: User (optional)

    Description:

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

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * and_list

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * operation

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

Created By: User (required)

Description:
operation to compare operand1 and operand2
  • operand1

    Type: str

    Created By: User (required)

    Description:

    UVE attribute specified in the dotted format. Example:

    NodeStatus.process_info.process_state

  • operand2

    Type: AlarmOperand2

    Created By: User (required)

    Description:

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

  • variables

    Type: str

    Created By: User (optional)

    Description:

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

    example, user may want to raise an alarm if the

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

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

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

    variables

class gen.resource_xsd.AlarmOperand2(uve_attribute=None, json_value=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * uve_attribute

Type: str

Created By: User (optional)

Description:

UVE attribute specified in the dotted format. Example:

NodeStatus.process_info.process_state

  • json_value

    Type: str

    Created By: User (optional)

    Description:

    json value as string

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * or_list

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * start

Type: str
  • end

    Type: str

  • vrouter_specific_pool

    Type: bool

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ip

  • mac

    Type: str

    Created By: User (optional)

  • address_mode

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

    Created By: User (optional)

    Description:

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

    Address-mode active-active is used for ECMP.

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * allowed_address_pair

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * api_access

Type: ApiAccessType

Created By: User (required)

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * api_name

Type: str

Created By: User (required)

  • permissions

    Type: PermType

    Created By: User (required)

class gen.resource_xsd.AsListType(asn_list=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * asn_list

Type: int
class gen.resource_xsd.AsnRangeType(asn_min=None, asn_max=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * asn_min

Type: int
  • asn_max

    Type: int

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes:

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * static

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * key_type

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

Created By: User (required)

Description:
Authentication type for this session. Currently only MD5 is supported.
  • key_items

    Type: AuthenticationKeyItem

    Created By: User (required)

    Description:

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

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * key_id

Type: int, within [0, 63]
  • key

    Type: str

class gen.resource_xsd.AutonomousSystemsType(asn=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * asn

Type: int, within [1, 4294967295]
class gen.resource_xsd.BGPaaSControlNodeZoneAttributes(bgpaas_control_node_zone_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * bgpaas_control_node_zone_type

Type: str, one-of [u’primary’, u’secondary’]

Created By: User (optional)

Description:

Specifies BGPaaSControlNodeZoneType. If bgpaas uses x.x.x.1 ip for

peering, BGPaaSControlNodeZoneType should be set to primary. If it

is x.x.x.2 ip for peering, BGPaaSControlNodeZoneType should be

secondary

class gen.resource_xsd.BGPaaServiceParametersType(port_start=50000, port_end=50512, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * port_start

Type: int, within [-1, 65535]
  • port_end

    Type: int, within [-1, 65535]

class gen.resource_xsd.BaremetalPortGroupInfo(standalone_ports_supported=None, node_uuid=None, properties=None, address=None, mode=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * standalone_ports_supported

Type: bool

Description:

Indicates whether ports that are members of this portgroup can be used as stand-

alone ports.

  • node_uuid

    Type: str

    Description:

    UUID of the parent node where this port is connected

  • properties

    Type: PortGroupProperties

    Description:

    Key/value properties related to the port group’s configuration.

  • address

    Type: str

    Description:

    Mac Address of the NIC in Node

  • mode

    Type: str

    Description:

    Mode of the port group

class gen.resource_xsd.BaremetalPortInfo(pxe_enabled=None, local_link_connection=None, node_uuid=None, address=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * pxe_enabled

Type: bool

Description:
Indicates whether PXE is enabled or disabled on the Port.
  • local_link_connection

    Type: LocalLinkConnection

    Description:

    The Port binding profile

  • node_uuid

    Type: str

    Description:

    UUID of the parent node where this port is connected

  • address

    Type: str

    Description:

    Mac Address of the NIC in Node

class gen.resource_xsd.BaremetalProperties(memory_mb=None, cpu_arch=None, local_gb=None, cpus=None, capabilities=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * memory_mb

Type: int

Description:
RAM of the Baremetal server (in MB)
  • cpu_arch

    Type: str

    Description:

    Architecture of the baremetal server

  • local_gb

    Type: int

    Description:

    Disk size of root device (in GB)

  • cpus

    Type: int

    Description:

    Number of CPU cores on the baremetal

  • capabilities

    Type: str

    Description:

    Boot option

class gen.resource_xsd.BaremetalServerInfo(network_interface=None, driver=None, properties=None, driver_info=None, name=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * network_interface

Type: str

Description:
Networking interface
  • driver

    Type: str

    Description:

    IPMI driver

  • properties

    Type: BaremetalProperties

    Description:

    Details of baremetal hardware for scheduler

  • driver_info

    Type: DriverInfo

    Description:

    Details of the driver for power management

  • name

    Type: str

    Description:

    Name of the Baremetal server

class gen.resource_xsd.BfdParameters(time_interval=None, detection_time_multiplier=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * time_interval

Type: int

Created By: User (optional)

Description:
Rx/Tx time interval for BFD session in milliseconds.
  • detection_time_multiplier

    Type: int

    Created By: User (optional)

    Description:

    Detection time multiplier for BFD session.

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * address_family

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

Created By: User (required)

Description:
Address family for which these parameters are applied.
  • loop_count

    Type: int, within [0, 16]

    Created By: User (optional)

    Description:

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

    routers AS is allowed in the AS_PATH attribute.

  • prefix_limit

    Type: BgpPrefixLimit

    Created By: User (optional)

    Description:

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

    received on the session for this address family.

  • default_tunnel_encap

    Type: str, one-of [u’gre’, u’mpls’, u’udp’, u’vxlan’]

    Created By: User (optional)

    Description:

    Default prioritized tunnel encapsulation list.

class gen.resource_xsd.BgpParameters(peer_autonomous_system=None, peer_ip_address=None, hold_time=0, auth_data=None, local_autonomous_system=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * peer_autonomous_system

Type: int

Created By: User (required)

Description:
Peer autonomous system number for this eBGP session.
  • peer_ip_address

    Type: str, one-of xsd:string

    Created By: User (required)

    Description:

    Peer ip address used for this eBGP session.

  • hold_time

    Type: int, within [0, 65535]

    Created By: User (optional)

    Description:

    BGP hold time in seconds [0-65535], Max time to detect liveliness to peer. Value

    0 will result in default value of 90 seconds

  • auth_data

    Type: AuthenticationData

    Created By: User (optional)

    Description:

    Authentication related configuration like type, keys etc.

  • local_autonomous_system

    Type: int

    Created By: User (optional)

    Description:

    BgpRouter specific Autonomous System number if different from global AS number.

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * session

Type: BgpSession

Created By: User (required)

Description:

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

BGP routers. Currently only 1 session is supported.

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * maximum

Type: int
  • idle_timeout

    Type: int, within [0, 86400]

    Created By: User (optional)

    Description:

    Time in seconds after which the session is allowed to re-establish after

    teardown.

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * admin_down

Type: bool

Created By: User (optional)

Description:
Administratively up or down.
  • vendor

    Type: str

    Created By: User (optional)

    Description:

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

  • cluster_id

    Type: int

    Created By: User (optional)

    Description:

    Cluster Id for this BGP router.

  • autonomous_system

    Type: int

    Created By: User (required)

    Description:

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

    supported. For contrail control nodes this has to be equal to global AS number.

  • identifier

    Type: str, one-of xsd:string

    Created By: User (required)

    Description:

    Router ID for this BGP router. Dotted ip notation. For contrail control-nodes

    System will automatically assign value of address field.

  • address

    Type: str, one-of xsd:string

    Created By: User (required)

    Description:

    Ip address used to reach this BGP router by the system.

  • port

    Type: int

    Created By: User (optional)

    Description:

    TCP port number on which BGP protocol connections are accepted. default is based

    on standareds.

  • source_port

    Type: int

    Description:

    For system internal use in BGPaaS service.

  • hold_time

    Type: int, within [0, 65535]

    Created By: User (optional)

    Description:

    BGP hold time in seconds [0-65535], Max time to detect liveliness to peer. Value

    0 will result in default value of 90 seconds

  • address_families

    Type: AddressFamilies

    Created By: User (optional)

    Description:

    BGP address families supported by BGP router

  • auth_data

    Type: AuthenticationData

    Created By: User (optional)

    Description:

    Authentication related configuration like type, keys etc.

  • local_autonomous_system

    Type: int

    Created By: User (optional)

    Description:

    BgpRouter specific Autonomous System number if different from global AS number.

    Typically used when clusters of control nodes in same contrail system are in

    different locations. Currently only 16 bit AS number is supported.

  • router_type

    Type: str, one-of [u’control-node’, u’external-control-node’, u’router’, u’bgpaas-server’, u’bgpaas-client’]

    Created By: User (optional)

    Description:

    BGP router type.

  • gateway_address

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    gateway-address field is used only for router-type bgpaas-client. It holds the

    ipv4 gateway address for the ipv4 subnet from which the client has IP address.

    The value is used as nexthop when advertising routes to the client via bgp.

  • ipv6_gateway_address

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    The ipv6-gateway-address field is used only for router-type bgpaas-client. It

    holds ipv6 gateway address for ipv6 subnet from which the client has IP address.

    The value is used as nexthop when advertising routes to the client via bgp.

    Note that the ipv6-gateway-address can be a regular ipv6 address or a ipv4

    -mapped-ipv6 adddress.

class gen.resource_xsd.BgpSession(uuid=None, attributes=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * uuid

Type: str

Created By: User (required)

Description:
When multiple sessions are present, each session must have an unique id.
  • attributes

    Type: BgpSessionAttributes

    Created By: User (required)

    Description:

    There can be upto 3 instances BGP session attributes, representing configuration

    for both ends and common. Currently only 1 instance representing common

    attributes is supported.

class gen.resource_xsd.BgpSessionAttributes(bgp_router=None, admin_down=False, passive=False, as_override=False, hold_time=0, loop_count=0, local_autonomous_system=0, address_families=None, auth_data=None, family_attributes=None, private_as_action=None, route_origin_override=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * bgp_router

Type: str

Created By: User (optional)

Description:

When the parameters are uni-directional the bgp-router element specifies to

which node the configuration applies. If missing the attributes apply to both

ends of the session.

  • admin_down

    Type: bool

    Created By: User (optional)

    Description:

    Administratively mark this session down.

  • passive

    Type: bool

    Created By: User (optional)

    Description:

    This is passive session. It will not initiated connection. This is not relevant

    when session attributes represent common part. It is recommended that it should

    not be set to true in current release.

  • as_override

    Type: bool

    Created By: User (optional)

    Description:

    To Be Added

  • hold_time

    Type: int, within [0, 65535]

    Created By: User (optional)

    Description:

    A non-zero hold-time overrides the hold-time inherited from the bgp-router

    configuration. BGP hold time in seconds [0-65535], Max time to detect liveliness

    of peer.

  • loop_count

    Type: int, within [0, 16]

    Created By: User (optional)

    Description:

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

    allowed in the AS_PATH attribute.

  • local_autonomous_system

    Type: int

    Created By: User (optional)

    Description:

    Local autonomous system number used for this particular session. If configured,

    this overrides autonomous-system number and local-autonomous-system number

    configured under BgpRouterParams

  • address_families

    Type: AddressFamilies

    Created By: User (optional)

    Description:

    BGP address families supported on this session.

  • auth_data

    Type: AuthenticationData

    Created By: User (optional)

    Description:

    Authentication related configuration for this session like type, keys etc.

  • family_attributes

    Type: BgpFamilyAttributes

    Created By: User (optional)

    Description:

    Session attributes over ride per BGP address family. Attributes like address

    family, loop-count and prefix-limit.

  • private_as_action

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

    Created By: User (optional)

    Description:

    Remove or replace private ASes from AS Path attributes advertised to this

    session.

  • route_origin_override

    Type: RouteOriginOverride

    Created By: User (optional)

    Description:

    User defined route origin value to override

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

Bases: gen.generatedssuper.GeneratedsSuper

Attributes:

class gen.resource_xsd.BridgeDomainMembershipType(vlan_tag=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * vlan_tag

Type: int, within [0, 4094]

Description:

VLAN tag of the incoming packet that maps the virtual-

machine-interface to bridge domain

class gen.resource_xsd.CliDiffInfoType(username=None, time=None, config_changes=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * username

Type: str
  • time

    Type: str

  • config_changes

    Type: str

class gen.resource_xsd.CliDiffListType(commit_diff_info=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * commit_diff_info

class gen.resource_xsd.CloudInstanceInfo(os_version=None, operating_system=None, roles=None, availability_zone=None, instance_type=None, machine_id=None, volume_size=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * os_version

Type: str

Description:
specific version of operating system
  • operating_system

    Type: str

    Description:

    Name of operating system, ex - centos7 or ubuntu16

  • roles

    Type: None

    Description:

    Roles of the cloud instance

  • availability_zone

    Type: str

    Description:

    Availability zone to which the instance belongs to

  • instance_type

    Type: str

    Description:

    size of instance

  • machine_id

    Type: str

    Description:

    image (ami) id of instance

  • volume_size

    Type: int

    Description:

    Size of the volume for the cloud instance

class gen.resource_xsd.CommunityAttributes(community_attribute=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * community_attribute

Type: str, one-of xsd:string

Description:

List of Community attributes, it indicates the attributes with which the routes

are tagged while publishing.

The attributes will be represented as bgp community in the path attribute.

Each attribute is indicated as string.

  1. String with two integers separated by ”:”. E.g. “64512:123”

  2. Well-known community as string.

    Possible values are “no-export” “accept-own” “no-advertise” “no-export-

subconfed” “no-reoriginate”

class gen.resource_xsd.CommunityListType(community=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * community

Type: str, one-of xsd:string

Description:

List of Community attributes, it indicates the attributes with which the routes

are tagged while publishing.

The attributes will be represented as bgp community in the path attribute.

Each attribute is indicated as string.

  1. String with two integers separated by ”:”. E.g. “64512:123”

  2. Well-known community as string.

    Possible values are “no-export” “accept-own” “no-advertise” “no-export-

subconfed” “no-reoriginate”

class gen.resource_xsd.ConnectionType(destination_instance=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * destination_instance

Type: str
class gen.resource_xsd.ControlTrafficDscpType(control=None, analytics=None, dns=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * control

Type: int, within [0, 63]

Created By: User (optional)

Description:
DSCP value for control protocols traffic
  • analytics

    Type: int, within [0, 63]

    Created By: User (optional)

    Description:

    DSCP value for traffic towards analytics

  • dns

    Type: int, within [0, 63]

    Created By: User (optional)

    Description:

    DSCP value for DNS traffic

class gen.resource_xsd.DefaultProtocolType(bgp=None, ospf=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * bgp

class gen.resource_xsd.DeviceCredential(credential=None, vendor=None, device_family=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * credential

Type: UserCredentials

Created By: User (required)

  • vendor

    Type: str

    Created By: User (optional)

  • device_family

    Type: str

    Created By: User (optional)

class gen.resource_xsd.DeviceCredentialList(device_credential=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * device_credential

class gen.resource_xsd.DeviceFamilyListType(device_family=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * device_family

Type: str
class gen.resource_xsd.DevicePlatformListType(platform_name=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * platform_name

Type: str
class gen.resource_xsd.DhcpOptionType(dhcp_option_name=None, dhcp_option_value=None, dhcp_option_value_bytes=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * dhcp_option_name

Type: str

Created By: User (required)

Description:
Name of the DHCP option
  • dhcp_option_value

    Type: str

    Created By: User (required)

    Description:

    Encoded DHCP option value (decimal)

  • dhcp_option_value_bytes

    Type: str

    Created By: User (required)

    Description:

    Value of the DHCP option to be copied byte by byte

class gen.resource_xsd.DhcpOptionsListType(dhcp_option=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * dhcp_option

Type: DhcpOptionType

Description:
List of DHCP options
class gen.resource_xsd.DiscoveryPubSubEndPointType(ep_type=None, ep_id=None, ep_prefix=None, ep_version=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ep_type

Type: str

Created By: User (required)

Description:
Type of service or client
  • ep_id

    Type: str

    Created By: User (optional)

    Description:

    Specific service or client which is set of one.

  • ep_prefix

    Type: SubnetType

    Created By: User (optional)

    Description:

    All servers or clients whose ip match this prefix

  • ep_version

    Type: str

    Created By: User (optional)

    Description:

    All servers or clients whose version match this version

class gen.resource_xsd.DiscoveryServiceAssignmentType(publisher=None, subscriber=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * publisher

Type: DiscoveryPubSubEndPointType

Created By: User (required)

Description:
Publisher set
class gen.resource_xsd.DnsSoaRecordType(negative_cache_ttl_seconds=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * negative_cache_ttl_seconds

Type: int

Created By: User (optional)

Description:
Default Time To Live for negative caching of DNS queries
class gen.resource_xsd.DnsmasqLeaseParameters(lease_expiry_time=None, client_id=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * lease_expiry_time

Type: int
  • client_id

    Type: str

class gen.resource_xsd.DomainLimitsType(project_limit=None, virtual_network_limit=None, security_group_limit=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * project_limit

Type: int

Created By: User (optional)

Description:
Maximum number of projects allowed in this domain
  • virtual_network_limit

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of virtual networks allowed in this domain

  • security_group_limit

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of security groups allowed in this domain

class gen.resource_xsd.DpdkInfo(cpu_core_mask=None, dpdk_uio_driver=None, huge_pages=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * cpu_core_mask

Type: str

Description:
CPU Core Mask
  • dpdk_uio_driver

    Type: str

    Description:

    UIO Driver

  • huge_pages

    Type: int

    Description:

    Hugepages Size

class gen.resource_xsd.DriverInfo(ipmi_address=None, deploy_ramdisk=None, ipmi_password=None, ipmi_port=None, ipmi_username=None, deploy_kernel=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ipmi_address

Type: str

Description:
IPMI address of the server to manage boot device and power management
  • deploy_ramdisk

    Type: str

    Description:

    UUID of the deploy initrd/ramdisk

  • ipmi_password

    Type: str

    Description:

    Password to access IPMI

  • ipmi_port

    Type: str

    Description:

    Remote IPMI RMCP port

  • ipmi_username

    Type: str

    Description:

    Username to access IPMI

  • deploy_kernel

    Type: str

    Description:

    UUID of the deploy kernel

class gen.resource_xsd.ESXIHostInfo(username=None, datacenter=None, esxi_name=None, cluster=None, mac=None, datastore=None, password=None, vcenter_server=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * username

Type: str

Description:
username
  • datacenter

    Type: str

    Description:

    datacenter in vCenter

  • esxi_name

    Type: str

    Description:

    ESXI host name(ip)

  • cluster

    Type: str

    Description:

    cluster in vCenter

  • mac

    Type: str

    Description:

    mac address for contrailvm

  • datastore

    Type: str

    Description:

    datastore in vCenter

  • password

    Type: str

    Description:

    ESXI host password

  • vcenter_server

    Type: str

    Description:

    vCenter server

class gen.resource_xsd.ESXIProperties(dvs_name=None, dvs_id=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * dvs_name

Type: str

Description:
Name of the Distributed Virtual Switch(DVS) assigned to Port.
  • dvs_id

    Type: str

    Description:

    MOid of the Distributed Virtual Switch(DVS) assigned to Port.

class gen.resource_xsd.EcmpHashingIncludeFields(hashing_configured=False, source_ip=True, destination_ip=True, ip_protocol=True, source_port=True, destination_port=True, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * hashing_configured

Type: bool

Created By: User (optional)

Description:

When True, Packet header fields used in calculating ECMP hash is decided by

following flags

  • source_ip

    Type: bool

    Created By: User (optional)

    Description:

    When false, do not use source ip in the ECMP hash calculation

  • destination_ip

    Type: bool

    Created By: User (optional)

    Description:

    When false, do not use destination ip in the ECMP hash calculation

  • ip_protocol

    Type: bool

    Created By: User (optional)

    Description:

    When false, do not use ip protocol in the ECMP hash calculation

  • source_port

    Type: bool

    Created By: User (optional)

    Description:

    When false, do not use source port in the ECMP hash calculation

  • destination_port

    Type: bool

    Created By: User (optional)

    Description:

    When false, do not use destination port in the ECMP hash calculation

class gen.resource_xsd.EnabledInterfaceParams(name=None, stats_collection_frequency=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * name

Type: str
class gen.resource_xsd.EncapsulationPrioritiesType(encapsulation=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * encapsulation

Type: str, one-of [u’MPLSoGRE’, u’MPLSoUDP’, u’VXLAN’]

Created By: User (optional)

Description:
Ordered list of encapsulation types to be used in priority
class gen.resource_xsd.EncryptionTunnelEndpoint(tunnel_remote_ip_address=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * tunnel_remote_ip_address

Type: str, one-of xsd:string

Created By: User (required)

Description:
Tunnel endpoint remote address
class gen.resource_xsd.EncryptionTunnelEndpointList(endpoint=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * endpoint

Type: EncryptionTunnelEndpoint

Description:
Tunnel endpoint remote address
class gen.resource_xsd.ExecutableInfoListType(executable_info=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * executable_info

class gen.resource_xsd.ExecutableInfoType(executable_path=None, executable_args=None, job_completion_weightage=100, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * executable_path

Type: str

Created By: User (required)

Description:
absolute path of the binary to execute
  • executable_args

    Type: str

    Created By: User (optional)

    Description:

    Optional arguments to be passed to the executable

  • job_completion_weightage

    Type: int

    Description:

    Job percentage completion when this executable is completed.

class gen.resource_xsd.ExtCommunityListType(community=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * community

Type: str
class gen.resource_xsd.FabricNetworkTag(network_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * network_type

Type: str, one-of [u’management’, u’loopback’, u’ip-fabric’, u’pnf-servicechain’]
class gen.resource_xsd.FatFlowProtocols(fat_flow_protocol=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * fat_flow_protocol

class gen.resource_xsd.FieldNamesList(field_names=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * field_names

Type: str
class gen.resource_xsd.FirewallRuleEndpointType(subnet=None, virtual_network=None, address_group=None, tags=None, tag_ids=None, any=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * subnet

Type: SubnetType

Created By: User (optional)

Description:
Any workload that belongs to this subnet
  • virtual_network

    Type: str

    Created By: User (optional)

    Description:

    Any workload that belongs to this virtual network

  • address_group

    Type: str

    Created By: User (optional)

    Description:

    Any workload with interface in this address-group

  • tags

    Type: str

    Created By: User (optional)

    Description:

    Any workload with tags matching tags in this list

  • tag_ids

    Type: int

    Description:

    Any workload with tags ids matching all the tags ids in this list

  • any

    Type: bool

    Created By: User (optional)

    Description:

    Match any workload

class gen.resource_xsd.FirewallRuleMatchTagsType(tag_list=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * tag_list

Type: TagType

Created By: User (required)

class gen.resource_xsd.FirewallRuleMatchTagsTypeIdList(tag_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * tag_type

Type: int

Created By: User (required)

class gen.resource_xsd.FirewallSequence(sequence=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * sequence

Type: str, one-of xsd:string

Created By: User (required)

class gen.resource_xsd.FirewallServiceGroupType(firewall_service=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * firewall_service

Type: FirewallServiceType

Created By: User (required)

class gen.resource_xsd.FirewallServiceType(protocol=None, protocol_id=None, src_ports=None, dst_ports=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str

Description:
Layer 4 protocol in ip packet
  • protocol_id

    Type: int

    Description:

    Layer 4 protocol id in ip packet

  • src_ports

    Type: PortType

    Description:

    Range of source port for layer 4 protocol

  • dst_ports

    Type: PortType

    Description:

    Range of destination port for layer 4 protocol

class gen.resource_xsd.FloatingIpPoolSubnetType(subnet_uuid=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * subnet_uuid

Type: str

Description:
List of subnets associated with this floating ip pool.
class gen.resource_xsd.FlowAgingTimeout(protocol=None, port=None, timeout_in_seconds=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str
  • port

    Type: int

  • timeout_in_seconds

    Type: int

class gen.resource_xsd.FlowAgingTimeoutList(flow_aging_timeout=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * flow_aging_timeout

Type: FlowAgingTimeout

Created By: User (optional)

Description:
List of (ip protocol, port number, timeout in seconds)
class gen.resource_xsd.GracefulRestartParametersType(enable=False, restart_time=300, long_lived_restart_time=300, end_of_rib_timeout=300, bgp_helper_enable=False, xmpp_helper_enable=False, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * enable

Type: bool

Description:
Enable/Disable knob for all GR parameters to take effect
  • restart_time

    Type: int, within [0, 4095]

    Description:

    Time (in seconds) taken by the restarting speaker to get back to stable state

  • long_lived_restart_time

    Type: int, within [0, 16777215]

    Description:

    Extended Time (in seconds) taken by the restarting speaker after restart-time to

    get back to stable state

  • end_of_rib_timeout

    Type: int, within [0, 4095]

    Description:

    Maximum time (in seconds) to wait for EndOfRib reception/transmission

  • bgp_helper_enable

    Type: bool

    Description:

    Enable GR Helper mode for BGP peers in contrail-control

  • xmpp_helper_enable

    Type: bool

    Description:

    Enable GR Helper mode for XMPP peers (agents) in contrail-control

class gen.resource_xsd.IdPermsType(permissions=None, uuid=None, enable=None, created=None, last_modified=None, description=None, user_visible=True, creator=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * permissions

Type: PermType

Created By: User (optional)

Description:
No longer used, will be removed
  • uuid

    Type: UuidType

    Created By: User (required)

    Description:

    UUID of the object, system automatically allocates one if not provided

  • enable

    Type: bool

    Created By: User (required)

    Description:

    Administratively Enable/Disable this object

  • created

    Type: xsd:dateTime

    Description:

    Time when this object was created

  • last_modified

    Type: xsd:dateTime

    Description:

    Time when this object was created

  • description

    Type: str

    Created By: User (optional)

    Description:

    User provided text

  • user_visible

    Type: bool

    Description:

    System created internal objects will have this flag set and will not be visible

  • creator

    Type: str

    Description:

    Id of tenant who created this object

class gen.resource_xsd.InstanceTargetType(import_export=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * import_export

Type: str, one-of [u’import’, u’export’]
class gen.resource_xsd.InterfaceMapType(port_info=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * port_info

class gen.resource_xsd.InterfaceMirrorType(traffic_direction=None, mirror_to=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * traffic_direction

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

Created By: User (required)

Description:
Specifies direction of traffic to mirror, Ingress, Egress or both
  • mirror_to

    Type: MirrorActionType

    Created By: User (required)

    Description:

    Mirror destination configuration

class gen.resource_xsd.IpAddressesType(ip_address=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ip_address

Type: str, one-of xsd:string

Description:
String of standard notation of ipv4 or ipv6 address
class gen.resource_xsd.IpamDnsAddressType(tenant_dns_server_address=None, virtual_dns_server_name=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * tenant_dns_server_address

Type: IpAddressesType

Created By: User (optional)

Description:

In case of tenant DNS server method, Ip address of DNS server. This will be

given in DHCP

  • virtual_dns_server_name

    Type: str

    Created By: User (optional)

    Description:

    In case of virtual DNS server, name of virtual DNS server

class gen.resource_xsd.IpamSubnetType(subnet=None, default_gateway=None, dns_server_address=None, subnet_uuid=None, enable_dhcp=True, dns_nameservers=None, allocation_pools=None, addr_from_start=None, dhcp_option_list=None, host_routes=None, subnet_name=None, alloc_unit=1, created=None, last_modified=None, subscriber_tag=None, vlan_tag=None, dhcp_relay_server=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * subnet

Type: SubnetType

Created By: User (required)

Description:
ip prefix and length for the subnet
  • default_gateway

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    default-gateway ip address in the subnet, if not provided one is auto generated

    by the system.

  • dns_server_address

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    DNS server ip address in the subnet, if not provided one is auto generated by

    the system.

  • subnet_uuid

    Type: str

    Description:

    Subnet UUID is auto generated by the system

  • enable_dhcp

    Type: bool

    Created By: User (optional)

    Description:

    Enable DHCP for the VM(s) in this subnet

  • dns_nameservers

    Type: str

    Created By: User (optional)

    Description:

    Tenant DNS servers ip address in tenant DNS method

  • allocation_pools

    Type: AllocationPoolType

    Created By: User (optional)

    Description:

    List of ranges of ip address within the subnet from which to allocate ip

    address. default is entire prefix

  • addr_from_start

    Type: bool

    Created By: User (optional)

    Description:

    Start address allocation from start or from end of address range.

  • dhcp_option_list

    Type: DhcpOptionsListType

    Created By: User (optional)

    Description:

    DHCP options list to be sent via DHCP for VM(s) in this subnet

  • host_routes

    Type: RouteTableType

    Created By: User (optional)

    Description:

    Host routes to be sent via DHCP for VM(s) in this subnet, Next hop for these

    routes is always default gateway

  • subnet_name

    Type: str

    Created By: User (optional)

    Description:

    User provided name for this subnet

  • alloc_unit

    Type: int

    Created By: User (optional)

    Description:

    allocation unit for this subnet to allocate bulk ip addresses

  • created

    Type: xsd:dateTime

    Created By: User (optional)

    Description:

    timestamp when subnet object gets created

  • last_modified

    Type: xsd:dateTime

    Created By: User (optional)

    Description:

    timestamp when subnet object gets updated

  • subscriber_tag

    Type: str

    Created By: User (optional)

    Description:

    This represents subscribers assigned ip addresses from this subnet for fabric

    peer network

  • vlan_tag

    Type: int

    Created By: User (optional)

    Description:

    vlan this subnet belongs to

  • dhcp_relay_server

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    DHCP relay server IP

class gen.resource_xsd.IpamSubnets(subnets=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * subnets

class gen.resource_xsd.IpamType(ipam_method=None, ipam_dns_method=None, ipam_dns_server=None, dhcp_option_list=None, cidr_block=None, host_routes=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ipam_method

Type: str, one-of [u’dhcp’, u’fixed’]

Created By: User (optional)

  • ipam_dns_method

    Type: str, one-of [u’none’, u’default-dns-server’, u’tenant-dns-server’, u’virtual-dns-server’]

    Created By: User (optional)

  • ipam_dns_server

    Type: IpamDnsAddressType

    Created By: User (optional)

  • dhcp_option_list

    Type: DhcpOptionsListType

    Created By: User (optional)

  • cidr_block

    Type: SubnetType

    Created By: User (optional)

  • host_routes

    Type: RouteTableType

    Created By: User (optional)

class gen.resource_xsd.JunosServicePorts(service_port=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * service_port

Type: str
class gen.resource_xsd.KeyValuePair(key=None, value=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * key

Type: str
  • value

    Type: str

class gen.resource_xsd.KeyValuePairs(key_value_pair=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * key_value_pair

class gen.resource_xsd.LinklocalServiceEntryType(linklocal_service_name=None, linklocal_service_ip=None, linklocal_service_port=None, ip_fabric_DNS_service_name=None, ip_fabric_service_port=None, ip_fabric_service_ip=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * linklocal_service_name

Type: str

Created By: User (required)

Description:

Name of the link local service. VM name resolution of this name will result in

link local ip address

  • linklocal_service_ip

    Type: str, one-of xsd:string

    Created By: User (required)

    Description:

    ip address of the link local service.

  • linklocal_service_port

    Type: int

    Created By: User (required)

    Description:

    Destination TCP port number of link local service

  • ip_fabric_DNS_service_name

    Type: str

    Created By: User (optional)

    Description:

    DNS name to which link local service will be proxied

  • ip_fabric_service_port

    Type: int

    Created By: User (required)

    Description:

    Destination TCP port number to which link local traffic will forwarded

  • ip_fabric_service_ip

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    Destination ip address to which link local traffic will forwarded

class gen.resource_xsd.LinklocalServicesTypes(linklocal_service_entry=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * linklocal_service_entry

Type: LinklocalServiceEntryType

Created By: User (optional)

Description:
List of link local services
class gen.resource_xsd.LoadbalancerHealthmonitorType(admin_state=True, monitor_type=None, delay=None, timeout=None, max_retries=None, http_method=None, url_path=None, expected_codes=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * admin_state

Type: bool

Created By: User (optional)

Description:
Administratively up or dowm.
  • monitor_type

    Type: str, one-of [u’PING’, u’TCP’, u’HTTP’, u’HTTPS’]

    Created By: User (required)

    Description:

    Protocol used to monitor health, PING, HTTP, HTTPS or TCP

  • delay

    Type: int

    Created By: User (required)

    Description:

    Time in seconds at which health check is repeated

  • timeout

    Type: int

    Created By: User (required)

    Description:

    Time in seconds to wait for response

  • max_retries

    Type: int

    Created By: User (required)

    Description:

    Number of failures before declaring health bad

  • http_method

    Type: str

    Created By: User (optional)

    Description:

    In case monitor protocol is HTTP, type of http method used like GET, PUT, POST

    etc

  • url_path

    Type: str

    Created By: User (optional)

    Description:

    In case monitor protocol is HTTP, URL to be used. In case of ICMP, ip address

  • expected_codes

    Type: str

    Created By: User (optional)

    Description:

    In case monitor protocol is HTTP, expected return code for HTTP operations like

    200 ok.

class gen.resource_xsd.LoadbalancerListenerType(protocol=None, protocol_port=None, admin_state=True, connection_limit=None, default_tls_container=None, sni_containers=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str, one-of [u’HTTP’, u’HTTPS’, u’TCP’, u’UDP’, u’TERMINATED_HTTPS’]
  • protocol_port

    Type: int

  • admin_state

    Type: bool

  • connection_limit

    Type: int

  • default_tls_container

    Type: str

  • sni_containers

    Type: str

class gen.resource_xsd.LoadbalancerMemberType(admin_state=True, status=None, status_description=None, protocol_port=None, weight=1, address=None, subnet_id=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * admin_state

Type: bool

Created By: User (optional)

Description:
Administrative up or down.
  • status

    Type: str

    Description:

    Operational status of the member.

  • status_description

    Type: str

    Description:

    Operational status description of the member.

  • protocol_port

    Type: int

    Created By: User (optional)

    Description:

    Destination port for the application on the member.

  • weight

    Type: int

    Created By: User (optional)

    Description:

    Weight for load balancing

  • address

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    Ip address of the member

  • subnet_id

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    UUID of the subnet from where the members are reachable.

class gen.resource_xsd.LoadbalancerPoolType(status=None, status_description=None, admin_state=True, protocol=None, loadbalancer_method=None, subnet_id=None, session_persistence=None, persistence_cookie_name=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * status

Type: str

Description:
Operating status for this loadbalancer pool.
  • status_description

    Type: str

    Description:

    Operating status description for this loadbalancer pool.

  • admin_state

    Type: bool

    Created By: User (optional)

    Description:

    Administrative up or down

  • protocol

    Type: str, one-of [u’HTTP’, u’HTTPS’, u’TCP’, u’UDP’, u’TERMINATED_HTTPS’]

    Created By: User (optional)

    Description:

    IP protocol string like http, https or tcp.

  • loadbalancer_method

    Type: str, one-of [u’ROUND_ROBIN’, u’LEAST_CONNECTIONS’, u’SOURCE_IP’]

    Created By: User (optional)

    Description:

    Load balancing method ROUND_ROBIN, LEAST_CONNECTIONS, or SOURCE_IP

  • subnet_id

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    UUID of the subnet from where the members of the pool are reachable.

  • session_persistence

    Type: str, one-of [u’SOURCE_IP’, u’HTTP_COOKIE’, u’APP_COOKIE’]

    Created By: User (optional)

    Description:

    Method for persistence. HTTP_COOKIE, SOURCE_IP or APP_COOKIE.

  • persistence_cookie_name

    Type: str

    Created By: User (optional)

    Description:

    To Be Added

class gen.resource_xsd.LoadbalancerType(status=None, provisioning_status=None, operating_status=None, vip_subnet_id=None, vip_address=None, admin_state=True, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * status

Type: str

Created By: User (optional)

Description:
Operational status of the load balancer updated by system.
  • provisioning_status

    Type: str

    Created By: User (optional)

    Description:

    Provisioning status of the load balancer updated by system.

  • operating_status

    Type: str

    Created By: User (optional)

    Description:

    Operational status of the load balancer updated by system.

  • vip_subnet_id

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    Subnet UUID of the subnet of VIP, representing virtual network.

  • vip_address

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    Virtual ip for this LBaaS

  • admin_state

    Type: bool

    Created By: User (optional)

    Description:

    Administrative up or down

class gen.resource_xsd.LocalLinkConnection(switch_info=None, port_index=None, port_id=None, switch_id=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * switch_info

Type: str

Description:
UUID of the Physical-Port with contrail database
  • port_index

    Type: str

    Description:

    Port-Id provided by LLDP, This usually maps to SnmpIndex

  • port_id

    Type: str

    Description:

    Port ID of switch where Baremetal is connected

  • switch_id

    Type: str

    Description:

    Switch hostname

class gen.resource_xsd.LogicalRouterVirtualNetworkType(logical_router_virtual_network_type='ExternalGateway', params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * logical_router_virtual_network_type

Type: str, one-of [u’ExternalGateway’, u’InternalVirtualNetwork’]

Created By: User (optional)

class gen.resource_xsd.MACLimitControlType(mac_limit=None, mac_limit_action='log', params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * mac_limit

Type: int

Created By: User (required)

Description:
Number of MACs that can be learnt
  • mac_limit_action

    Type: str, one-of [u’log’, u’alarm’, u’shutdown’, u’drop’]

    Created By: User (optional)

    Description:

    Action to be taken when MAC limit exceeds

class gen.resource_xsd.MACMoveLimitControlType(mac_move_limit=None, mac_move_time_window=10, mac_move_limit_action='log', params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * mac_move_limit

Type: int

Created By: User (required)

Description:
Number of MAC moves permitted in mac move time window
  • mac_move_time_window

    Type: int, within [1, 60]

    Created By: User (required)

    Description:

    MAC move time window

  • mac_move_limit_action

    Type: str, one-of [u’log’, u’alarm’, u’shutdown’, u’drop’]

    Created By: User (optional)

    Description:

    Action to be taken when MAC move limit exceeds

class gen.resource_xsd.MacAddressesType(mac_address=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * mac_address

Type: None
class gen.resource_xsd.MatchConditionType(protocol=None, src_address=None, src_port=None, dst_address=None, dst_port=None, ethertype=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str

Created By: User (required)

Description:
Layer 4 protocol in ip packet
  • src_address

    Type: AddressType

    Created By: User (required)

    Description:

    Source ip matching criteria

  • src_port

    Type: PortType

    Created By: User (required)

    Description:

    Range of source port for layer 4 protocol

  • dst_address

    Type: AddressType

    Created By: User (required)

    Description:

    Destination ip matching criteria

  • dst_port

    Type: PortType

    Created By: User (required)

    Description:

    Range of destination port for layer 4 protocol

  • ethertype

    Type: str, one-of [u’IPv4’, u’IPv6’]

    Created By: User (required)

class gen.resource_xsd.MirrorActionType(analyzer_name=None, encapsulation=None, analyzer_ip_address=None, analyzer_mac_address=None, routing_instance=None, udp_port=None, juniper_header=True, nh_mode=None, static_nh_header=None, nic_assisted_mirroring=False, nic_assisted_mirroring_vlan=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * analyzer_name

Type: str

Created By: User (optional)

Description:
Name of service instance used as analyzer
  • encapsulation

    Type: str

    Created By: User (optional)

    Description:

    Encapsulation for Mirrored packet, not used currently

  • analyzer_ip_address

    Type: str, one-of xsd:string

    Created By: User (required)

    Description:

    ip address of interface to which mirrored packets are sent

  • analyzer_mac_address

    Type: str

    Created By: User (optional)

    Description:

    mac address of interface to which mirrored packets are sent

  • routing_instance

    Type: str

    Created By: User (required)

    Description:

    Routing instance for the virtual network which analyzer is in

  • udp_port

    Type: int

    Created By: User (optional)

    Description:

    ip udp port used in contrail default encapsulation for mirroring

  • juniper_header

    Type: bool

    Created By: User (optional)

    Description:

    This flag is used to determine with/without juniper-header

  • nh_mode

    Type: str, one-of [u’dynamic’, u’static’]

    Created By: User (optional)

    Description:

    This mode used to determine static or dynamic nh

  • static_nh_header

    Type: StaticMirrorNhType

    Created By: User (optional)

    Description:

    vtep details required if static nh enabled

  • nic_assisted_mirroring

    Type: bool

    Created By: User (optional)

    Description:

    This flag is used to select nic assisted mirroring

  • nic_assisted_mirroring_vlan

    Type: int, within [0, 4094]

    Created By: User (optional)

    Description:

    The VLAN to be tagged on the traffic for NIC to Mirror

class gen.resource_xsd.MulticastSourceGroup(source_address=None, group_address=None, action=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * source_address

Type: str, one-of xsd:string

Created By: User (required)

Description:
Multicast Source Address
  • group_address

    Type: str, one-of xsd:string

    Created By: User (required)

    Description:

    Multicast Group Address

  • action

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

    Created By: User (required)

    Description:

    Pass or deny action for (S,G) matching this rule

class gen.resource_xsd.MulticastSourceGroups(multicast_source_group=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * multicast_source_group

class gen.resource_xsd.NamespaceValue(ipv4_cidr=None, asn=None, mac_addr=None, asn_ranges=None, serial_nums=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ipv4_cidr

Type: SubnetListType

Created By: User (optional)

Description:
Namespace as IPV4 CIDR addresses
  • asn

    Type: AutonomousSystemsType

    Created By: User (optional)

    Description:

    Namespace as Autonomous System Numbers

  • mac_addr

    Type: MacAddressesType

    Created By: User (optional)

    Description:

    Namespace as MAC addresses

  • asn_ranges

    Type: AsnRangeType

    Created By: User (optional)

    Description:

    Namespace as ASN ranges

  • serial_nums

    Type: str

    Created By: User (optional)

    Description:

    Namespace as MAC addresses

class gen.resource_xsd.NodeProfileRoleType(physical_role=None, rb_roles=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * physical_role

Type: str
  • rb_roles

    Type: str

class gen.resource_xsd.NodeProfileRolesType(role_mappings=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * role_mappings

class gen.resource_xsd.PermType(owner=None, owner_access=None, group=None, group_access=None, other_access=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * owner

Type: str
  • owner_access

    Type: int, within [0, 7]

    Description:

    Three bits representing rwx.

    r=read permission,

    w=write permission,

    x=reference permission

  • group

    Type: str

  • group_access

    Type: int, within [0, 7]

    Description:

    Three bits representing rwx.

    r=read permission,

    w=write permission,

    x=reference permission

  • other_access

    Type: int, within [0, 7]

    Description:

    Three bits representing rwx.

    r=read permission,

    w=write permission,

    x=reference permission

class gen.resource_xsd.PermType2(owner=None, owner_access=7, global_access=0, share=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * owner

Type: str

Created By: User (required)

Description:
Owner tenant of the object
  • owner_access

    Type: int, within [0, 7]

    Created By: User (required)

    Description:

    Owner permissions of the object

  • global_access

    Type: int, within [0, 7]

    Created By: User (optional)

    Description:

    Globally(others) shared object and permissions for others of the object

  • share

    Type: ShareType

    Created By: User (optional)

    Description:

    Selectively shared object, List of (tenant, permissions)

class gen.resource_xsd.PlaybookInfoListType(playbook_info=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * playbook_info

class gen.resource_xsd.PlaybookInfoType(playbook_uri=None, multi_device_playbook=False, vendor=None, device_family=None, job_completion_weightage=100, sequence_no=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * playbook_uri

Type: str

Created By: User (required)

Description:
uri to the playbook location on the file server
  • multi_device_playbook

    Type: bool

    Description:

    if set to true, the execute-job action url uses the job-template parameter

    ‘device-list’ to execute the playbook in parallel

  • vendor

    Type: str

    Created By: User (optional)

    Description:

    Vendor name

  • device_family

    Type: str

    Created By: User (optional)

    Description:

    Device family name

  • job_completion_weightage

    Type: int

    Description:

    Job percentage completion when this playbook is completed. This attribute value

    should 100 if there is only one playbook defined in the job template. The job-

    completion-weigtages for all playbooks in the same job-template should add up to

    100 exact.

  • sequence_no

    Type: int

    Created By: User (optional)

    Description:

    Sequence number of the playbook

class gen.resource_xsd.PluginProperties(plugin_property=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * plugin_property

Type: PluginProperty

Created By: User (optional)

Description:
List of plugin specific properties (property, value)
class gen.resource_xsd.PluginProperty(property=None, value=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * property

Type: str
  • value

    Type: str

class gen.resource_xsd.PolicyBasedForwardingRuleType(direction=None, vlan_tag=None, src_mac=None, dst_mac=None, mpls_label=None, service_chain_address=None, ipv6_service_chain_address=None, protocol=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * direction

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

    Type: int

  • src_mac

    Type: str

  • dst_mac

    Type: str

  • mpls_label

    Type: int

  • service_chain_address

    Type: str, one-of xsd:string

  • ipv6_service_chain_address

    Type: str, one-of xsd:string

    Description:

    String of standard notation of ipv4 or ipv6 address

  • protocol

    Type: str

class gen.resource_xsd.PolicyEntriesType(policy_rule=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * policy_rule

Type: PolicyRuleType

Created By: User (required)

Description:
List of policy rules
class gen.resource_xsd.PolicyRuleType(rule_sequence=None, rule_uuid=None, direction=None, protocol=None, src_addresses=None, src_ports=None, application=None, dst_addresses=None, dst_ports=None, action_list=None, ethertype=None, created=None, last_modified=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * rule_sequence

Type: SequenceType

Created By: User (optional)

Description:
Deprecated, Will be removed because rules themselves are already an ordered list
  • rule_uuid

    Type: str

    Created By: User (optional)

    Description:

    Rule UUID is identifier used in flow records to identify rule

  • direction

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

    Created By: User (required)

  • protocol

    Type: str

    Created By: User (required)

    Description:

    Layer 4 protocol in ip packet

  • src_addresses

    Type: AddressType

    Created By: User (required)

    Description:

    Source ip matching criteria

  • src_ports

    Type: PortType

    Created By: User (required)

    Description:

    Range of source port for layer 4 protocol

  • application

    Type: str

    Created By: User (optional)

    Description:

    Optionally application can be specified instead of protocol and port. not

    currently implemented

  • dst_addresses

    Type: AddressType

    Created By: User (required)

    Description:

    Destination ip matching criteria

  • dst_ports

    Type: PortType

    Created By: User (required)

    Description:

    Range of destination port for layer 4 protocol

  • action_list

    Type: ActionListType

    Created By: User (required)

    Description:

    Actions to be performed if packets match condition

  • ethertype

    Type: str, one-of [u’IPv4’, u’IPv6’]

    Created By: User (required)

  • created

    Type: xsd:dateTime

    Created By: User (optional)

    Description:

    timestamp when security group rule object gets created

  • last_modified

    Type: xsd:dateTime

    Created By: User (optional)

    Description:

    timestamp when security group rule object gets updated

class gen.resource_xsd.PolicyStatementType(term=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * term

class gen.resource_xsd.PolicyTermType(term_match_condition=None, term_action_list=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * term_match_condition

class gen.resource_xsd.PortGroupProperties(miimon=None, xmit_hash_policy=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * miimon

Type: int

Description:
Specifies the MII link monitoring frequency in milliseconds.
  • xmit_hash_policy

    Type: str

    Description:

    Transmit hash policy to use for slave selection in balance-xor, 802.3ad, and tlb

    modes.

class gen.resource_xsd.PortInfoType(name=None, type_=None, port_speed=None, channelized=False, channelized_port_speed=None, port_group=None, labels=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * name

Type: str
  • type

    Type: str, one-of [u’fc’, u’ge’, u’xe’, u’xle’, u’et’, u’fte’, u’me’, u’em’]

  • port_speed

    Type: str, one-of [u‘1G’, u‘10G’, u‘40G’, u‘100G’]

  • channelized

    Type: bool

  • channelized_port_speed

    Type: str, one-of [u‘1G’, u‘10G’, u‘40G’, u‘100G’]

  • port_group

    Type: str

  • labels

    Type: str

class gen.resource_xsd.PortMap(protocol=None, src_port=None, dst_port=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str
  • src_port

    Type: int

  • dst_port

    Type: int

class gen.resource_xsd.PortMappings(port_mappings=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * port_mappings

Type: PortMap
class gen.resource_xsd.PortTranslationPool(protocol=None, port_range=None, port_count=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str
  • port_range

    Type: PortType

    Created By: User (optional)

    Description:

    Port range to be reserved for per layer 4 protocol for PAT

  • port_count

    Type: unsignedShort

    Created By: User (optional)

    Description:

    Number of ports per layer 4 protocol to be reserved for PAT

class gen.resource_xsd.PortTranslationPools(port_translation_pool=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * port_translation_pool

class gen.resource_xsd.PortType(start_port=0, end_port=65535, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * start_port

Type: int, within [-1, 65535]

Created By: User (required)

  • end_port

    Type: int, within [-1, 65535]

    Created By: User (required)

class gen.resource_xsd.PrefixMatchType(prefix=None, prefix_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * prefix

Type: str
  • prefix_type

    Type: str, one-of [u’exact’, u’longer’, u’orlonger’]

class gen.resource_xsd.ProtocolBgpType(autonomous_system=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * autonomous_system

Type: int
class gen.resource_xsd.ProtocolOspfType(area=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * area

Type: int
class gen.resource_xsd.ProtocolStaticType(route=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * route

Type: IpPrefixType
class gen.resource_xsd.ProtocolType(protocol=None, port=None, ignore_address=None, source_prefix=None, source_aggregate_prefix_length=None, destination_prefix=None, destination_aggregate_prefix_length=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str
  • port

    Type: int

  • ignore_address

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

    Created By: User (optional)

    Description:

    Address ignored while creating flows, from the perspective of packets egressing

    the VM. For packets originated by VM, source and destination indicate the

    corresponding IPs in the packet. For packets coming from remote source, source

    indicates destination IP of the packet is ignored and destination indicates

    source IP of the packet is ignored.

  • source_prefix

    Type: SubnetType

    Created By: User (optional)

    Description:

    For packets originated from VM source-prefix is applied to source IP of the

    packet. For packets coming to VM, source-prefix is applied to destination IP of

    the packet

  • source_aggregate_prefix_length

    Type: int

    Created By: User (optional)

    Description:

    Fat flow prefix mask length for IP where source-prefix is applied

  • destination_prefix

    Type: SubnetType

    Created By: User (optional)

    Description:

    For packets originated from VM destination-prefix is applied to destination IP

    of the packet. For packets coming to VM, destination-prefix is applied to source

    IP of the packet

  • destination_aggregate_prefix_length

    Type: int

    Created By: User (optional)

    Description:

    Fat flow prefix mask length for IP where destination-prefix is applied

class gen.resource_xsd.ProviderDetails(segmentation_id=None, physical_network=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * segmentation_id

Type: int, within [0, 4094]
  • physical_network

    Type: str

class gen.resource_xsd.QosIdForwardingClassPair(key=None, forwarding_class_id=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * key

Type: int

Description:
QoS bit value (DSCP or Vlan priority or EXP bit value
  • forwarding_class_id

    Type: int, within [0, 255]

class gen.resource_xsd.QosIdForwardingClassPairs(qos_id_forwarding_class_pair=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * qos_id_forwarding_class_pair

class gen.resource_xsd.QuotaType(defaults=None, floating_ip=None, instance_ip=None, virtual_machine_interface=None, virtual_network=None, virtual_router=None, virtual_DNS=None, virtual_DNS_record=None, bgp_router=None, network_ipam=None, access_control_list=None, network_policy=None, floating_ip_pool=None, service_template=None, service_instance=None, logical_router=None, security_group=None, security_group_rule=None, subnet=None, global_vrouter_config=None, loadbalancer_pool=None, loadbalancer_member=None, loadbalancer_healthmonitor=None, virtual_ip=None, security_logging_object=None, route_table=None, firewall_group=None, firewall_policy=None, firewall_rule=None, host_based_service=0, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * defaults

Type: int

Created By: User (optional)

Description:
Need to clarify
  • floating_ip

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of floating ips

  • instance_ip

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of instance ips

  • virtual_machine_interface

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of virtual machine interfaces

  • virtual_network

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of virtual networks

  • virtual_router

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of logical routers

  • virtual_DNS

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of virtual DNS servers

  • virtual_DNS_record

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of virtual DNS records

  • bgp_router

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of bgp routers

  • network_ipam

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of network IPAMs

  • access_control_list

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of access control lists

  • network_policy

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of network policies

  • floating_ip_pool

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of floating ip pools

  • service_template

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of service templates

  • service_instance

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of service instances

  • logical_router

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of logical routers

  • security_group

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of security groups

  • security_group_rule

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of security group rules

  • subnet

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of subnets

  • global_vrouter_config

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of global vrouter configs

  • loadbalancer_pool

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of loadbalancer pools

  • loadbalancer_member

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of loadbalancer member

  • loadbalancer_healthmonitor

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of loadbalancer health monitors

  • virtual_ip

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of virtual ips

  • security_logging_object

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of security logging objects

  • route_table

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of route tables

  • firewall_group

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of application policy set

  • firewall_policy

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of firewall policy

  • firewall_rule

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of firewall rule

  • host_based_service

    Type: int, within [0, 1]

    Created By: User (optional)

    Description:

    Maximum number of host based service. Actually limited to 0 or 1 for a project

    (can not be unlimited or more than 1)

class gen.resource_xsd.RbacPermType(role_name=None, role_crud=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * role_name

Type: str

Created By: User (required)

Description:
Name of the role
  • role_crud

    Type: str

    Created By: User (required)

    Description:

    String CRUD representing permissions for C=create, R=read, U=update, D=delete.

class gen.resource_xsd.RbacRuleEntriesType(rbac_rule=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * rbac_rule

class gen.resource_xsd.RbacRuleType(rule_object=None, rule_field=None, rule_perms=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * rule_object

Type: str

Created By: User (required)

Description:
Name of the REST API (object) for this rule, * represent all objects
  • rule_field

    Type: str

    Created By: User (optional)

    Description:

    Name of the level one field (property) for this object, * represent all

    properties

  • rule_perms

    Type: RbacPermType

    Created By: User (required)

    Description:

    List of [(role, permissions),...]

class gen.resource_xsd.RouteListType(route=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * route

Type: str
class gen.resource_xsd.RouteOriginOverride(origin_override=False, origin='IGP', params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * origin_override

Type: bool

Created By: User (optional)

Description:
Set true to override Route origin with the given value
  • origin

    Type: str, one-of [u’IGP’, u’EGP’, u’INCOMPLETE’]

    Created By: User (optional)

    Description:

    User define route origin value

class gen.resource_xsd.RouteTableType(route=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * route

Type: RouteType

Description:
List of ip routes with following fields.
class gen.resource_xsd.RouteTargetList(route_target=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * route_target

Type: str
class gen.resource_xsd.RouteType(prefix=None, next_hop=None, next_hop_type=None, community_attributes=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * prefix

Type: str

Description:
Ip prefix/len format prefix
  • next_hop

    Type: str

    Description:

    Ip address or service instance name.

  • next_hop_type

    Type: str, one-of [u’service-instance’, u’ip-address’]

  • community_attributes

    Type: CommunityAttributes

class gen.resource_xsd.RoutedProperties(physical_router_uuid=None, routed_interface_ip_address=None, routing_protocol=None, bgp_params=None, static_route_params=None, bfd_params=None, routing_policy_params=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * physical_router_uuid

Type: str

Created By: User (required)

Description:
Routed properties for particular physical router for this virtual-network.
  • routed_interface_ip_address

    Type: str, one-of xsd:string

    Created By: User (required)

    Description:

    IP address of the routed interface from the VN subnet.

  • routing_protocol

    Type: str, one-of [u’static-routes’, u’bgp’]

    Created By: User (required)

  • bgp_params

    Type: BgpParameters

    Created By: User (optional)

    Description:

    BGP parameters such as ASN, peer IP address, authentication method/key.

  • static_route_params

    Type: StaticRouteParameters

    Created By: User (optional)

    Description:

    Static route parameters such as interface route table uuid, next hop IP address.

  • bfd_params

    Type: BfdParameters

    Created By: User (optional)

    Description:

    BFD parameters such as time interval, detection time multiplier.

  • routing_policy_params

    Type: RoutingPolicyParameters

    Created By: User (optional)

    Description:

    List of import/export routing policy uuids.

class gen.resource_xsd.RoutingBridgingRolesType(rb_roles=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * rb_roles

Type: str
class gen.resource_xsd.RoutingPolicyParameters(import_routing_policy_uuid=None, export_routing_policy_uuid=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * import_routing_policy_uuid

Type: str

Created By: User (optional)

Description:
list of routing policy uuids used as import policies.
  • export_routing_policy_uuid

    Type: str

    Created By: User (optional)

    Description:

    list of routing policy uuids used as export policies.

class gen.resource_xsd.RoutingPolicyServiceInstanceType(left_sequence=None, right_sequence=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Description:

A given routing policy could be attached to both left or right interface of a

service instance. If it is the case, set both the left-sequence and right-

sequence. If you only want to attach it to either left or right, but not both,

then only set the corresponding sequence number. A value of None also means it

is not attached to that interface.

Attributes: * left_sequence

Type: str, one-of xsd:string
  • right_sequence

    Type: str, one-of xsd:string

class gen.resource_xsd.RoutingPolicyType(sequence=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * sequence

Type: str, one-of xsd:string
class gen.resource_xsd.SNMPCredentials(version=2, local_port=None, retries=None, timeout=None, v2_community=None, v3_security_name=None, v3_security_level=None, v3_security_engine_id=None, v3_context=None, v3_context_engine_id=None, v3_authentication_protocol=None, v3_authentication_password=None, v3_privacy_protocol=None, v3_privacy_password=None, v3_engine_id=None, v3_engine_boots=None, v3_engine_time=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * version

Type: int
  • local_port

    Type: int

  • retries

    Type: int

  • timeout

    Type: int

  • v2_community

    Type: str

  • v3_security_name

    Type: str

  • v3_security_level

    Type: str

  • v3_security_engine_id

    Type: str

  • v3_context

    Type: str

  • v3_context_engine_id

    Type: str

  • v3_authentication_protocol

    Type: str

  • v3_authentication_password

    Type: str

  • v3_privacy_protocol

    Type: str

  • v3_privacy_password

    Type: str

  • v3_engine_id

    Type: str

  • v3_engine_boots

    Type: int

  • v3_engine_time

    Type: int

class gen.resource_xsd.SecurityLoggingObjectRuleEntryType(rule_uuid=None, rate=100, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * rule_uuid

Type: str

Created By: User (optional)

Description:

Rule UUID of network policy or security-group. When this is absent it implies

all rules of security-group or network-policy

  • rate

    Type: int

    Created By: User (optional)

    Description:

    Rate at which sessions are logged. When rates are specified at multiple levels,

    the rate which specifies highest frequency is selected

class gen.resource_xsd.SecurityLoggingObjectRuleListType(rule=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * rule

Type: SecurityLoggingObjectRuleEntryType

Created By: User (optional)

Description:

List of rules along with logging rate for each rule. Both rule-uuid and rate are

optional. When rule-uuid is absent then it means all rules of associated SG or

network-policy

class gen.resource_xsd.SequenceType(major=None, minor=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * major

Type: int

Created By: User (required)

  • minor

    Type: int

    Created By: User (required)

class gen.resource_xsd.SerialNumListType(serial_num=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * serial_num

Type: str
class gen.resource_xsd.ServiceApplianceInterfaceType(interface_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * interface_type

Type: str, one-of xsd:string
class gen.resource_xsd.ServiceChainInfo(routing_instance=None, prefix=None, service_chain_address=None, service_instance=None, source_routing_instance=None, service_chain_id=None, sc_head=False, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * routing_instance

Type: str
  • prefix

    Type: str

  • service_chain_address

    Type: str, one-of xsd:string

  • service_instance

    Type: str

  • source_routing_instance

    Type: str

  • service_chain_id

    Type: str

  • sc_head

    Type: bool

class gen.resource_xsd.ServiceHealthCheckType(enabled=False, health_check_type=None, monitor_type=None, delay=None, delayUsecs=0, timeout=None, timeoutUsecs=0, max_retries=None, http_method=None, url_path=None, expected_codes=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * enabled

Type: bool

Created By: User (optional)

Description:
Administratively enable or disable this health check.
  • health_check_type

    Type: str, one-of [u’link-local’, u’end-to-end’, u’segment’]

    Created By: User (required)

    Description:

    Health check type, currently only link-local, end-to-end and segment are

    supported

  • monitor_type

    Type: str, one-of [u’PING’, u’HTTP’, u’BFD’]

    Created By: User (required)

    Description:

    Protocol used to monitor health, currently only HTTP, ICMP(ping), and BFD are

    supported

  • delay

    Type: int

    Created By: User (required)

    Description:

    Time in seconds at which health check is repeated

  • delayUsecs

    Type: int

    Created By: User (optional)

    Description:

    Time in micro seconds at which health check is repeated

  • timeout

    Type: int

    Created By: User (required)

    Description:

    Time in seconds to wait for response

  • timeoutUsecs

    Type: int

    Created By: User (optional)

    Description:

    Time in micro seconds to wait for response

  • max_retries

    Type: int

    Created By: User (required)

    Description:

    Number of failures before declaring health bad

  • http_method

    Type: str

    Created By: User (optional)

    Description:

    In case monitor protocol is HTTP, type of http method used like GET, PUT, POST

    etc

  • url_path

    Type: str

    Created By: User (optional)

    Description:

    In case monitor protocol is HTTP, URL to be used. In case of ICMP, ip address

  • expected_codes

    Type: str

    Created By: User (optional)

    Description:

    In case monitor protocol is HTTP, expected return code for HTTP operations like

    200 ok.

class gen.resource_xsd.ServiceInstanceInterfaceType(virtual_network=None, ip_address=None, static_routes=None, allowed_address_pairs=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * virtual_network

Type: str

Created By: User (required)

Description:
Interface belongs to this virtual network.
  • ip_address

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    Shared ip for this interface (Only V1)

  • static_routes

    Type: RouteTableType

    Created By: User (optional)

    Description:

    Static routes for this interface (Only V1)

  • allowed_address_pairs

    Type: AllowedAddressPairs

    Created By: User (optional)

    Description:

    Allowed address pairs, list of (IP address, MAC) for this interface

class gen.resource_xsd.ServiceInstanceType(auto_policy=False, availability_zone=None, management_virtual_network=None, left_virtual_network=None, left_ip_address=None, right_virtual_network=None, right_ip_address=None, interface_list=None, scale_out=None, ha_mode=None, virtual_router_id=None, service_virtualization_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * auto_policy

Type: bool

Description:

Set when system creates internal service chains, example SNAT with router

external flag in logical router

  • availability_zone

    Type: str

    Created By: User (optional)

    Description:

    Availability zone used to spawn VM(s) for this service instance, used in version

    1 (V1) only

  • management_virtual_network

    Type: str

    Created By: User (optional)

    Description:

    Deprecated

  • left_virtual_network

    Type: str

    Created By: User (optional)

    Description:

    Deprecated

  • left_ip_address

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    Deprecated

  • right_virtual_network

    Type: str

    Created By: User (optional)

    Description:

    Deprecated

  • right_ip_address

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    Deprecated

  • interface_list

    Type: ServiceInstanceInterfaceType

    Created By: User (required)

    Description:

    List of service instance interface properties. Ordered list as per service

    template

  • scale_out

    Type: ServiceScaleOutType

    Created By: User (optional)

    Description:

    Number of virtual machines in this service instance, used in version 1 (V1) only

  • ha_mode

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

    Created By: User (optional)

    Description:

    When scale-out is greater than one, decides if active-active or active-backup,

    used in version 1 (V1) only

  • virtual_router_id

    Type: str

    Created By: User (optional)

    Description:

    UUID of a virtual-router on which this service instance need to spawn. Used to

    spawn services on CPE device when Nova is not present

  • service_virtualization_type

    Type: str, one-of [u’virtual-machine’, u’network-namespace’, u’vrouter-instance’, u’physical-device’]

    Created By: User (optional)

    Description:

    Service virtualization type decides how individual service instances are

    instantiated

class gen.resource_xsd.ServiceInterfaceTag(interface_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * interface_type

Type: str, one-of xsd:string
class gen.resource_xsd.ServiceScaleOutType(max_instances=1, auto_scale=False, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * max_instances

Type: int

Created By: User (required)

Description:
Maximum number of scale out factor(virtual machines). can be changed dynamically
  • auto_scale

    Type: bool

    Created By: User (required)

    Description:

    Automatically change the number of virtual machines. Not implemented

class gen.resource_xsd.ServiceTemplateInterfaceType(service_interface_type=None, shared_ip=False, static_route_enable=False, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * service_interface_type

Type: str, one-of xsd:string

Created By: User (required)

Description:
Type of service interface supported by this template left, right or other.
  • shared_ip

    Type: bool

    Created By: User (optional)

    Description:

    Shared ip is required on this interface when service instance is scaled out

    (Only V1)

  • static_route_enable

    Type: bool

    Created By: User (optional)

    Description:

    Static routes configured required on this interface of service instance (Only

    V1)

class gen.resource_xsd.ServiceTemplateType(version=1, service_mode=None, service_type=None, image_name=None, service_scaling=False, interface_type=None, flavor=None, ordered_interfaces=False, service_virtualization_type=None, availability_zone_enable=False, vrouter_instance_type=None, instance_data=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * version

Type: int

Created By: User (optional)

Description:

Version of service template.

1: Service virtual machines and interfaces are automatically launched,

monitored and deleted.

2: User creates all objects( virtual machines and interfaces) and manages

the life cycle.

Useful when virtual machines and interfaces are managed via heat template
  • service_mode

    Type: str, one-of [u’transparent’, u’in-network’, u’in-network-nat’]

    Created By: User (required)

    Description:

    Service instance mode decides how packets are forwarded across the service

  • service_type

    Type: str, one-of [u’firewall’, u’analyzer’, u’source-nat’, u’loadbalancer’]

    Created By: User (required)

    Description:

    Service instance mode decides how routing happens across the service

  • image_name

    Type: str

    Created By: User (optional)

    Description:

    Glance image name for the service virtual machine, Version 1 only

  • service_scaling

    Type: bool

    Created By: User (optional)

    Description:

    Enable scaling of service virtual machines, Version 1 only

  • interface_type

    Type: ServiceTemplateInterfaceType

    Created By: User (required)

    Description:

    List of interfaces which decided number of interfaces and type

  • flavor

    Type: str

    Created By: User (optional)

    Description:

    Nova flavor used for service virtual machines, Version 1 only

  • ordered_interfaces

    Type: bool

    Created By: User (optional)

    Description:

    Deprecated

  • service_virtualization_type

    Type: str, one-of [u’virtual-machine’, u’network-namespace’, u’vrouter-instance’, u’physical-device’]

    Created By: User (optional)

    Description:

    Service virtualization type decides how individual service instances are

    instantiated

  • availability_zone_enable

    Type: bool

    Created By: User (optional)

    Description:

    Enable availability zone for version 1 service instances

  • vrouter_instance_type

    Type: str, one-of [u’libvirt-qemu’, u’docker’]

    Created By: User (optional)

    Description:

    Mechanism used to spawn service instance, when vrouter is spawning

    instances.Allowed values libvirt-qemu, docker or netns

  • instance_data

    Type: str

    Created By: User (optional)

    Description:

    Opaque string (typically in json format) used to spawn a vrouter-instance.

class gen.resource_xsd.ServiceVirtualNetworkType(virtual_network_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * virtual_network_type

Type: str, one-of xsd:string
class gen.resource_xsd.SflowParameters(stats_collection_frequency=None, agent_id=None, adaptive_sample_rate=300, enabled_interface_type=None, enabled_interface_params=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * stats_collection_frequency

Type: StatsCollectionFrequency

Description:

Represents polling interval and sample rate either at the global level or at per

interface level. Polling interval is specified in seconds that the device waits

between port statistics update messages. Sample rate is specified as a number

(one packet out of number).

  • agent_id

    Type: str, one-of xsd:string

    Description:

    IP address to be assigned as the agent ID for the sFlow agent.

  • adaptive_sample_rate

    Type: int, within [300, 900]

    Created By: User (optional)

    Description:

    Represents maximum number of samples that should be generated per line card.

  • enabled_interface_type

    Type: str, one-of [u’all’, u’fabric’, u’service’, u’access’, u’custom’]

    Description:

    User can enable sflow either on all interfaces or all fabric ports or all access

    ports or custom list of interfaces.

  • enabled_interface_params

    Type: EnabledInterfaceParams

    Description:

    If interface type is set to custom, this represents the list of physical

    interfaces to be enabled for sflow. User can specify polling interval and sample

    rate for each interface in this custom list.

class gen.resource_xsd.ShareType(tenant=None, tenant_access=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * tenant

Type: str

Created By: User (required)

Description:
Name of tenant with whom the object is shared
  • tenant_access

    Type: int, within [0, 7]

    Created By: User (required)

    Description:

    Allowed permissions in sharing

class gen.resource_xsd.SloRateType(rate=-1, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * rate

Type: int

Description:
Rate at which sessions are logged
class gen.resource_xsd.SriovInfo(sriov_physical_interface=None, sriov_vf=None, sriov_physical_net=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * sriov_physical_interface

Type: str

Description:
SRIOV Physical Interface
  • sriov_vf

    Type: int

    Description:

    SRIOV Virtual Function

  • sriov_physical_net

    Type: str

    Description:

    SRIOV Physical Network

class gen.resource_xsd.StaticMirrorNhType(vtep_dst_ip_address=None, vtep_dst_mac_address=None, vni=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * vtep_dst_ip_address

Type: str, one-of xsd:string

Created By: User (required)

Description:
ip address of destination vtep
  • vtep_dst_mac_address

    Type: str

    Created By: User (optional)

    Description:

    mac address of destination vtep

  • vni

    Type: int, within [1, 16777215]

    Created By: User (required)

    Description:

    Vni of vtep

class gen.resource_xsd.StaticRouteEntriesType(route=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * route

class gen.resource_xsd.StaticRouteParameters(interface_route_table_uuid=None, next_hop_ip_address=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * interface_route_table_uuid

Type: str

Created By: User (required)

Description:
list of interface route table uuids used to build list of prefixes.
  • next_hop_ip_address

    Type: str, one-of xsd:string

    Created By: User (required)

    Description:

    List of next-hop IP addresses.

class gen.resource_xsd.StaticRouteType(prefix=None, next_hop=None, route_target=None, community=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * prefix

Type: str
  • next_hop

    Type: str

  • route_target

    Type: str

  • community

    Type: str

class gen.resource_xsd.StatsCollectionFrequency(sample_rate=2000, polling_interval=20, direction=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * sample_rate

Type: int, within [1, 16777215]

Created By: User (optional)

  • polling_interval

    Type: int, within [0, 3600]

    Created By: User (optional)

  • direction

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

    Created By: User (optional)

class gen.resource_xsd.StormControlParameters(storm_control_actions=None, recovery_timeout=None, no_unregistered_multicast=False, no_registered_multicast=False, no_unknown_unicast=False, no_multicast=False, no_broadcast=False, bandwidth_percent=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * storm_control_actions

Type: str, one-of [u’interface-shutdown’]

Description:

Default action (Discard) is implicit. In addition, other list of actions can be

specified here

  • recovery_timeout

    Type: int

    Created By: User (optional)

    Description:

    Timeout in seconds. This enables the affected interface to recover automatically

    from the error condition after the specified period of time

  • no_unregistered_multicast

    Type: bool

    Description:

    if set to true, disable unregistered multicast traffic storm control

  • no_registered_multicast

    Type: bool

    Description:

    if set to true, disable registered multicast traffic storm control

  • no_unknown_unicast

    Type: bool

    Description:

    if set to true, disable unknown unicast traffic storm control

  • no_multicast

    Type: bool

    Description:

    if set to true, disable muticast traffic storm control

  • no_broadcast

    Type: bool

    Description:

    if set to true, disable broadcast traffic storm control

  • bandwidth_percent

    Type: int

    Created By: User (required)

    Description:

    Configure storm control bandwidth level as percentage

class gen.resource_xsd.StructuredSyslogLinkType(overlay=None, underlay=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * overlay

Type: str
  • underlay

    Type: str

class gen.resource_xsd.StructuredSyslogLinkmap(links=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * links

class gen.resource_xsd.SubnetListType(subnet=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * subnet

class gen.resource_xsd.SubnetType(ip_prefix=None, ip_prefix_len=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ip_prefix

Type: str
  • ip_prefix_len

    Type: int

class gen.resource_xsd.TelemetryResourceInfo(name=None, path=None, rate=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * name

Type: str
  • path

    Type: str

  • rate

    Type: str

class gen.resource_xsd.TelemetryStateInfo(resource=None, server_ip=None, server_port=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * resource

  • server_ip

    Type: str

  • server_port

    Type: int

class gen.resource_xsd.TermActionListType(update=None, action=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * update

  • action

    Type: str, one-of [u’reject’, u’accept’, u’next’]

class gen.resource_xsd.TermMatchConditionType(protocol=None, prefix=None, community=None, community_list=None, community_match_all=None, extcommunity_list=None, extcommunity_match_all=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * protocol

Type: str, one-of [u’bgp’, u’xmpp’, u’static’, u’service-chain’, u’aggregate’, u’interface’, u’interface-static’, u’service-interface’, u’bgpaas’]
  • prefix

    Type: PrefixMatchType

  • community

    Type: str

  • community_list

    Type: str

  • community_match_all

    Type: bool

  • extcommunity_list

    Type: str

  • extcommunity_match_all

    Type: bool

class gen.resource_xsd.TimerType(start_time=None, on_interval=None, off_interval=None, end_time=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * start_time

Type: xsd:dateTime

Created By: User (required)

  • on_interval

    Type: str

    Created By: User (required)

  • off_interval

    Type: str

    Created By: User (required)

  • end_time

    Type: xsd:dateTime

    Created By: User (required)

class gen.resource_xsd.UserCredentials(username=None, password=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * username

Type: str
  • password

    Type: str

class gen.resource_xsd.UserDefinedLogStat(name=None, pattern=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * name

Type: str

Created By: User (required)

Description:
Name of the stat
  • pattern

    Type: str

    Created By: User (required)

    Description:

    Perl type regular expression pattern to match

class gen.resource_xsd.UserDefinedLogStatList(statlist=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * statlist

class gen.resource_xsd.UuidType(uuid_mslong=None, uuid_lslong=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * uuid_mslong

Type: int
  • uuid_lslong

    Type: int

class gen.resource_xsd.UveKeysType(uve_key=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * uve_key

Type: str

Created By: User (required)

Description:
List of UVE tables where this alarm config should be applied
class gen.resource_xsd.VendorHardwaresType(vendor_hardware=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * vendor_hardware

Type: str
class gen.resource_xsd.VirtualDnsRecordType(record_name=None, record_type=None, record_class=None, record_data=None, record_ttl_seconds=None, record_mx_preference=None, record_source_name=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * record_name

Type: str

Created By: User (required)

Description:
DNS name to be resolved
  • record_type

    Type: str, one-of [u’A’, u’AAAA’, u’CNAME’, u’PTR’, u’NS’, u’MX’]

    Created By: User (optional)

    Description:

    DNS record type can be A, AAAA, CNAME, PTR, NS and MX

  • record_class

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

    Created By: User (optional)

    Description:

    DNS record class supported is IN

  • record_data

    Type: str

    Created By: User (required)

    Description:

    DNS record data is either ip address or string depending on type

  • record_ttl_seconds

    Type: int

    Created By: User (optional)

    Description:

    Time To Live for this DNS record

  • record_mx_preference

    Type: int

    Created By: User (optional)

  • record_source_name

    Type: str

    Description:

    name of the compute node which sends add for A type or PTR type dns record for

    vm

class gen.resource_xsd.VirtualDnsType(domain_name=None, dynamic_records_from_client=None, record_order='random', default_ttl_seconds=None, next_virtual_DNS=None, floating_ip_record=None, external_visible=False, reverse_resolution=False, soa_record=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * domain_name

Type: str

Created By: User (required)

Description:
Default domain name for this virtual DNS server
  • dynamic_records_from_client

    Type: bool

    Created By: User (optional)

    Description:

    Allow automatic addition of records on VM launch, default is True

  • record_order

    Type: str, one-of [u’fixed’, u’random’, u’round-robin’]

    Created By: User (optional)

    Description:

    Order of DNS load balancing, fixed, random, round-robin. Default is random

  • default_ttl_seconds

    Type: int

    Created By: User (optional)

    Description:

    Default Time To Live for DNS records

  • next_virtual_DNS

    Type: str

    Created By: User (optional)

    Description:

    Next virtual DNS server to lookup if record is not found. Default is proxy to

    infrastructure DNS

  • floating_ip_record

    Type: str, one-of [u’dashed-ip’, u’dashed-ip-tenant-name’, u’vm-name’, u’vm-name-tenant-name’]

    Created By: User (optional)

    Description:

    Decides how floating ip records are added

  • external_visible

    Type: bool

    Created By: User (optional)

    Description:

    Currently this option is not supported

  • reverse_resolution

    Type: bool

    Created By: User (optional)

    Description:

    Allow reverse DNS resolution, ip to name mapping

  • soa_record

    Type: DnsSoaRecordType

    Created By: User (optional)

    Description:

    Dns soa record values

class gen.resource_xsd.VirtualIpType(address=None, status=None, status_description=None, admin_state=True, protocol=None, protocol_port=None, connection_limit=None, subnet_id=None, persistence_cookie_name=None, persistence_type=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * address

Type: str, one-of xsd:string

Description:
IP address automatically allocated by system.
  • status

    Type: str

    Description:

    Operating status for this virtual ip.

  • status_description

    Type: str

    Description:

    Operating status description this virtual ip.

  • admin_state

    Type: bool

    Created By: User (optional)

    Description:

    Administrative up or down.

  • protocol

    Type: str, one-of [u’HTTP’, u’HTTPS’, u’TCP’, u’UDP’, u’TERMINATED_HTTPS’]

    Created By: User (optional)

    Description:

    IP protocol string like http, https or tcp.

  • protocol_port

    Type: int

    Created By: User (optional)

    Description:

    Layer 4 protocol destination port.

  • connection_limit

    Type: int

    Created By: User (optional)

    Description:

    Maximum number of concurrent connections

  • subnet_id

    Type: str, one-of xsd:string

    Created By: User (optional)

    Description:

    UUID of subnet in which to allocate the Virtual IP.

  • persistence_cookie_name

    Type: str

    Created By: User (optional)

    Description:

    Set this string if the relation of client and server(pool member) need to

    persist.

  • persistence_type

    Type: str, one-of [u’SOURCE_IP’, u’HTTP_COOKIE’, u’APP_COOKIE’]

    Created By: User (optional)

    Description:

    Method for persistence. HTTP_COOKIE, SOURCE_IP or APP_COOKIE.

class gen.resource_xsd.VirtualMachineInterfacePropertiesType(service_interface_type=None, interface_mirror=None, local_preference=None, sub_interface_vlan_tag=None, max_flows=0, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * service_interface_type

Type: str, one-of xsd:string

Created By: User (optional)

Description:
This interface belongs to Service Instance and is tagged as left, right or other
  • interface_mirror

    Type: InterfaceMirrorType

    Created By: User (optional)

    Description:

    Interface Mirror configuration

  • local_preference

    Type: int

    Created By: User (optional)

    Description:

    BGP route local preference for routes representing this interface, higher value

    is higher preference

  • sub_interface_vlan_tag

    Type: int

    Created By: User (optional)

    Description:

    802.1Q VLAN tag to be used if this interface is sub-interface for some other

    interface.

  • max_flows

    Type: int, within [0, 4294967296]

    Created By: User (optional)

    Description:

    Maximum number of flows permitted on VMI

class gen.resource_xsd.VirtualNetworkPolicyType(sequence=None, timer=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * sequence

Type: SequenceType

Created By: User (optional)

Description:
Sequence number to specify order of policy attachment to network
  • timer

    Type: TimerType

    Created By: User (optional)

    Description:

    Timer to specify when the policy can be active

class gen.resource_xsd.VirtualNetworkRoutedPropertiesType(routed_properties=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * routed_properties

Type: RoutedProperties

Description:
List of routed properties for virtual network.
class gen.resource_xsd.VirtualNetworkType(allow_transit=None, network_id=None, vxlan_network_identifier=None, forwarding_mode=None, rpf=None, mirror_destination=False, max_flows=0, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * allow_transit

Type: bool

Created By: User (optional)

Description:

Enables transitive property for route imports.

If B imports routes of A and C imports from B,

then if B is transitive then C will have routes from A.

  • network_id

    Type: int

    Description:

    Not currently in used

  • vxlan_network_identifier

    Type: int, within [1, 16777215]

    Created By: User (required)

    Description:

    VxLAN VNI value for this network

  • forwarding_mode

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

    Created By: User (optional)

    Description:

    Packet forwarding mode for this virtual network

  • rpf

    Type: str, one-of [u’enable’, u’disable’]

    Created By: User (optional)

    Description:

    Flag used to disable Reverse Path Forwarding(RPF) check for this network

  • mirror_destination

    Type: bool

    Created By: User (optional)

    Description:

    Flag to mark the virtual network as mirror destination network

  • max_flows

    Type: int, within [0, 4294967296]

    Created By: User (optional)

    Description:

    Maximum number of flows permitted on each VMI of the VN

class gen.resource_xsd.VirtualRouterNetworkIpamType(allocation_pools=None, subnet=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * allocation_pools

Type: AllocationPoolType

Created By: User (optional)

Description:
List of ranges of ip address for vrouter specific allocation
  • subnet

    Type: SubnetType

    Created By: User (optional)

    Description:

    List of ip prefix and length for vrouter specific subnets

class gen.resource_xsd.VnSubnetsType(ipam_subnets=None, host_routes=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ipam_subnets

  • host_routes

    Type: RouteTableType

    Created By: User (optional)

    Description:

    Common host routes to be sent via DHCP for VM(s) in all the subnets, Next hop

    for these routes is always default gateway

class gen.resource_xsd.VpgInterfaceParametersType(ae_num=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * ae_num

Type: int
class gen.resource_xsd.VrfAssignRuleType(match_condition=None, vlan_tag=None, routing_instance=None, ignore_acl=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * match_condition

  • vlan_tag

    Type: int

  • routing_instance

    Type: str

  • ignore_acl

    Type: bool

class gen.resource_xsd.VrfAssignTableType(vrf_assign_rule=None, params_dict=None, **kwargs)

Bases: gen.generatedssuper.GeneratedsSuper

Attributes: * vrf_assign_rule

Table Of Contents

Previous topic

Library API Details

This Page