Skip to content

Commit

Permalink
Auto generated from specifications change.
Browse files Browse the repository at this point in the history
  • Loading branch information
nuagebot committed Nov 4, 2020
1 parent 1a88202 commit a483d21
Show file tree
Hide file tree
Showing 569 changed files with 35,044 additions and 357 deletions.
Binary file modified doc/conf.pyc
Binary file not shown.
6 changes: 6 additions & 0 deletions doc/v6/nuaddressmap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,14 @@ Attributes

- ``last_updated_by``: ID of the user who last updated the object.

- ``last_updated_date``: Time stamp when this object was last updated.

- ``embedded_metadata``: Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

- ``entity_scope``: Specify if scope of entity is Data center or Enterprise level

- ``creation_date``: Time stamp when this object was created.

- ``private_ip`` (**Mandatory**): Private IP address of the interface

- ``private_port``: None
Expand All @@ -28,6 +32,8 @@ Attributes

- ``public_port``: None

- ``owner``: Identifies the user that has created this object.

- ``external_id``: External object ID. Used for integration with third party systems

- ``type``: Identifies the type of address mapping
Expand Down
6 changes: 6 additions & 0 deletions doc/v6/nuaddressrange.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Attributes

- ``last_updated_by``: ID of the user who last updated the object.

- ``last_updated_date``: Time stamp when this object was last updated.

- ``max_address`` (**Mandatory**): Highest address in the address range

- ``min_address`` (**Mandatory**): Lowest address in the address range
Expand All @@ -26,6 +28,10 @@ Attributes

- ``entity_scope``: Specify if scope of entity is Data center or Enterprise level

- ``creation_date``: Time stamp when this object was created.

- ``owner``: Identifies the user that has created this object.

- ``external_id``: External object ID. Used for integration with third party systems


Expand Down
6 changes: 6 additions & 0 deletions doc/v6/nuaggregateddomain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ Attributes

- ``last_updated_by``: ID of the user who last updated the object.

- ``last_updated_date``: Time stamp when this object was last updated.

- ``advertise_criteria``: Set this attribute to allow the spoke domain routes to be leaked into the hub domain.

- ``leaking_enabled``: Indicates if this domain is a leakable domain or not - boolean true/false
Expand Down Expand Up @@ -104,6 +106,8 @@ Attributes

- ``create_back_haul_subnet``: Determines if BackHaul Subnet should be created or not.

- ``creation_date``: Time stamp when this object was created.

- ``associated_bgp_profile_id``: None

- ``associated_multicast_channel_map_id``: The ID of the Multi Cast Channel Map this domain is associated with. This has to be set when enableMultiCast is set to ENABLED
Expand All @@ -122,6 +126,8 @@ Attributes

- ``customer_id``: The customerID that is created in the VSC and identifies this dVRS. This is auto-generated by VSD

- ``owner``: Identifies the user that has created this object.

- ``export_route_target``: Route target associated with the dVRS. It is an optional parameterthat can be provided by the user or auto-managed by VSDSystem generates this identifier automatically, if not provided

- ``external_id``: External object ID. Used for integration with third party systems
Expand Down
18 changes: 13 additions & 5 deletions doc/v6/nualarm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Attributes

- ``last_updated_by``: ID of the user who last updated the object.

- ``last_updated_date``: Time stamp when this object was last updated.

- ``acknowledged``: Flag to indicate if the alarm has been acknowledged already.

- ``remedy``: Remedial Actions for the alarm.
Expand All @@ -36,13 +38,17 @@ Attributes

- ``entity_scope``: Specify if scope of entity is Data center or Enterprise level

- ``creation_date``: Time stamp when this object was created.

- ``error_condition``: Identifies the error condition

- ``number_of_occurances``: Number of times that the alarm was triggered

- ``owner``: Identifies the user that has created this object.

- ``external_id``: External object ID. Used for integration with third party systems

- ``system_id``: System ID of the Gateway.
- ``system_id``: System ID of the Gateway



Expand All @@ -66,18 +72,20 @@ Parents

- :ref:`nuaggregateddomain.NUAggregatedDomain<nuaggregateddomain>`

- :ref:`nuazurecloud.NUAzureCloud<nuazurecloud>`

- :ref:`nuredundancygroup.NURedundancyGroup<nuredundancygroup>`

- :ref:`nushuntlink.NUShuntLink<nushuntlink>`

- :ref:`nunsredundantgatewaygroup.NUNSRedundantGatewayGroup<nunsredundantgatewaygroup>`

- :ref:`nuikegatewayconnection.NUIKEGatewayConnection<nuikegatewayconnection>`

- :ref:`nugatewayredundantport.NUGatewayRedundantPort<nugatewayredundantport>`

- :ref:`nudomain.NUDomain<nudomain>`

- :ref:`nuvsc.NUVSC<nuvsc>`

- :ref:`nuvport.NUVPort<nuvport>`

- :ref:`nucontainer.NUContainer<nucontainer>`
Expand Down Expand Up @@ -106,6 +114,8 @@ Parents

- :ref:`nunsgateway.NUNSGateway<nunsgateway>`

- :ref:`nuvsc.NUVSC<nuvsc>`

- :ref:`nuvsd.NUVSD<nuvsd>`

- :ref:`nuvm.NUVM<nuvm>`
Expand All @@ -114,8 +124,6 @@ Parents

- :ref:`nuport.NUPort<nuport>`

- :ref:`nunsredundantgatewaygroup.NUNSRedundantGatewayGroup<nunsredundantgatewaygroup>`

- :ref:`nuethernetsegmentgwgroup.NUEthernetSegmentGWGroup<nuethernetsegmentgwgroup>`

- :ref:`nuenterprise.NUEnterprise<nuenterprise>`
Expand Down
8 changes: 7 additions & 1 deletion doc/v6/nuallalarm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Attributes

- ``last_updated_by``: ID of the user who last updated the object.

- ``last_updated_date``: Time stamp when this object was last updated.

- ``acknowledged``: Flag to indicate that alarm is already acknowledged or not

- ``remedy``: Remedial actions for the alarm.
Expand All @@ -36,13 +38,17 @@ Attributes

- ``entity_scope``: Specify if scope of entity is Data center or Enterprise level

- ``creation_date``: Time stamp when this object was created.

- ``error_condition``: Identifies the error condition

- ``number_of_occurances``: Number of times that the alarm was triggered

- ``owner``: Identifies the user that has created this object.

- ``external_id``: External object ID. Used for integration with third party systems

- ``system_id``: System ID of the Gateway.
- ``system_id``: System ID of the Gateway



Expand Down
6 changes: 6 additions & 0 deletions doc/v6/nuallgateway.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Attributes

- ``last_updated_by``: ID of the user who last updated the object.

- ``last_updated_date``: Time stamp when this object was last updated.

- ``datapath_id``: Identifier of the Gateway, based on the systemID which is generated when the instance is created in VSD.

- ``patches``: Patches that have been installed on the NSG
Expand Down Expand Up @@ -72,6 +74,8 @@ Attributes

- ``bootstrap_status``: The bootstrap status of this Gateway. NOTE: This is a read only property.

- ``creation_date``: Time stamp when this object was created.

- ``product_name``: Product Name as reported during bootstrapping.

- ``use_gateway_vlanvnid``: When set, VLAN-VNID mapping must be unique for all the vports of the gateway
Expand All @@ -88,6 +92,8 @@ Attributes

- ``auto_disc_gateway_id``: The Auto Discovered Gateway associated with this Gateway Instance

- ``owner``: Identifies the user that has created this object.

- ``external_id``: External object ID. Used for integration with third party systems

- ``system_id``: Identifier of the Gateway, cannot be modified after creation
Expand Down
6 changes: 6 additions & 0 deletions doc/v6/nuallredundancygroup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Attributes

- ``last_updated_by``: ID of the user who last updated the object.

- ``last_updated_date``: Time stamp when this object was last updated.

- ``gateway_peer1_autodiscovered_gateway_id``: The Auto Discovered Gateway configuration owner in this Redundant Group.

- ``gateway_peer1_connected``: Indicates status of the authoritative gateway of this Redundancy Group.
Expand Down Expand Up @@ -44,8 +46,12 @@ Attributes

- ``entity_scope``: Specify if scope of entity is Data center or Enterprise level

- ``creation_date``: Time stamp when this object was created.

- ``vtep``: Represent the system ID or the Virtual IP of a service used by a Gateway (VSG for now) to establish a tunnel with a remote VSG or hypervisor. The format of this field is consistent with an IP address.

- ``owner``: Identifies the user that has created this object.

- ``external_id``: External object ID. Used for integration with third party systems


Expand Down
10 changes: 8 additions & 2 deletions doc/v6/nuapplication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Attributes

- ``last_updated_by``: ID of the user who last updated the object.

- ``last_updated_date``: Time stamp when this object was last updated.

- ``read_only``: determines whether this entity is read only. Read only objects cannot be modified or deleted.

- ``performance_monitor_type``: Describes the trigger for the application.
Expand All @@ -30,7 +32,7 @@ Attributes

- ``destination_ip``: destination IP in CIDR format

- ``destination_port``: value should be either * or single port number
- ``destination_port``: value should be either * or single port number or maximum 5 ranges comma separated.

- ``network_symmetry``: Network symmetry flag

Expand All @@ -50,20 +52,24 @@ Attributes

- ``source_ip``: source IP address

- ``source_port``: source Port ,value should be either * or single port number
- ``source_port``: source Port ,value should be either * or single port number or maximum 5 ranges comma separated.

- ``app_id``: a unique 2 byte id generated when a application is created and used by VRS for probing.

- ``optimize_path_selection``: with values being Latency, Jitter, PacketLoss

- ``pre_classification_path``: default set to primary , possible values primary/secondary

- ``creation_date``: Time stamp when this object was created.

- ``protocol``: Protocol number that must be matched

- ``associated_l7_application_signature_id``: associated Layer7 Application Type ID

- ``ether_type``: Ether type of the packet to be matched. etherType can be * or a valid hexadecimal value

- ``owner``: Identifies the user that has created this object.

- ``external_id``: External object ID. Used for integration with third party systems

- ``symmetry``: Maintain path symmetry during SLA violation
Expand Down
6 changes: 6 additions & 0 deletions doc/v6/nuapplicationbinding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,22 @@ Attributes

- ``last_updated_by``: ID of the user who last updated the object.

- ``last_updated_date``: Time stamp when this object was last updated.

- ``read_only``: Determines whether this entity is read only.

- ``embedded_metadata``: Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

- ``entity_scope``: Specify if scope of entity is Data center or Enterprise level

- ``creation_date``: Time stamp when this object was created.

- ``priority``: Priority of the Application within an Application Group

- ``associated_application_id`` (**Mandatory**): Associated software application ID

- ``owner``: Identifies the user that has created this object.

- ``external_id``: External object ID. Used for integration with third party systems


Expand Down
6 changes: 6 additions & 0 deletions doc/v6/nuapplicationperformancemanagement.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Attributes

- ``last_updated_by``: ID of the user who last updated the object.

- ``last_updated_date``: Time stamp when this object was last updated.

- ``read_only``: Determines whether this entity is read only. Read only objects cannot be modified or deleted.

- ``description``: Description of Application Group
Expand All @@ -26,8 +28,12 @@ Attributes

- ``app_group_unique_id``: 2 byte Id to uniquely identify Application Group between OVS, nuage_dpi and perfd processes for proper functioning of AAR.

- ``creation_date``: Time stamp when this object was created.

- ``associated_performance_monitor_id``: associated Probe ID

- ``owner``: Identifies the user that has created this object.

- ``external_id``: External object ID. Used for integration with third party systems


Expand Down
6 changes: 6 additions & 0 deletions doc/v6/nuapplicationperformancemanagementbinding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,22 @@ Attributes

- ``last_updated_by``: ID of the user who last updated the object.

- ``last_updated_date``: Time stamp when this object was last updated.

- ``read_only``: Determines whether this entity is read only. Read only objects cannot be modified or deleted.

- ``embedded_metadata``: Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.

- ``entity_scope``: Specify if scope of entity is Data center or Enterprise level

- ``creation_date``: Time stamp when this object was created.

- ``priority``: Priority of the associated Application Group

- ``associated_application_performance_management_id`` (**Mandatory**): Associated Application Group ID

- ``owner``: Identifies the user that has created this object.

- ``external_id``: External object ID. Used for integration with third party systems


Expand Down
6 changes: 6 additions & 0 deletions doc/v6/nuautodiscovercluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,16 @@ Attributes

- ``last_updated_by``: ID of the user who last updated the object.

- ``last_updated_date``: Time stamp when this object was last updated.

- ``entity_scope``: Specify if scope of entity is Data center or Enterprise level

- ``creation_date``: Time stamp when this object was created.

- ``assoc_vcenter_data_center_id``: The ID of the vcenter to which this host is attached

- ``owner``: Identifies the user that has created this object.

- ``external_id``: External object ID. Used for integration with third party systems


Expand Down
6 changes: 6 additions & 0 deletions doc/v6/nuautodiscovereddatacenter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,16 @@ Attributes

- ``last_updated_by``: ID of the user who last updated the object.

- ``last_updated_date``: Time stamp when this object was last updated.

- ``entity_scope``: Specify if scope of entity is Data center or Enterprise level

- ``creation_date``: Time stamp when this object was created.

- ``associated_vcenter_id``: The ID of the vcenter to which this host is attached

- ``owner``: Identifies the user that has created this object.

- ``external_id``: External object ID. Used for integration with third party systems


Expand Down
6 changes: 6 additions & 0 deletions doc/v6/nuautodiscoveredgateway.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Attributes

- ``last_updated_by``: ID of the user who last updated the object.

- ``last_updated_date``: Time stamp when this object was last updated.

- ``gateway_id``: The Gateway associated with this Auto Discovered Gateway. This is a read only attribute

- ``peer``: The System ID of the peer gateway associated with this Gateway instance when it is discovered by the network manager (VSD) as being redundant.
Expand All @@ -30,8 +32,12 @@ Attributes

- ``controllers``: Controllers to which this gateway instance is associated with.

- ``creation_date``: Time stamp when this object was created.

- ``vtep``: Represent the system ID or the Virtual IP of a service used by a Gateway (VSG for now) to establish a tunnel with a remote VSG or hypervisor. The format of this field is consistent with an IP address.

- ``owner``: Identifies the user that has created this object.

- ``external_id``: External object ID. Used for integration with third party systems

- ``system_id``: Identifier of the Gateway
Expand Down
Loading

0 comments on commit a483d21

Please sign in to comment.