diff --git a/README.md b/README.md index df44f4161..f78f11f8a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ ## The IxNetwork Python Client + [![pypi](https://img.shields.io/pypi/v/ixnetwork-restpy.svg)](https://pypi.org/project/ixnetwork-restpy) [![python](https://img.shields.io/pypi/pyversions/ixnetwork-restpy.svg)](https://pypi.python.org/pypi/ixnetwork-restpy) [![license](https://img.shields.io/badge/license-MIT-green.svg)](https://en.wikipedia.org/wiki/MIT_License) diff --git a/RELEASENOTES.md b/RELEASENOTES.md index 2e1028139..66f4658f6 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -1,4 +1,7 @@ # Release Notes +### January 2023 +* 1.1.8 + * support ixnetwork version 9.30.2212.7 (9.30 EA) ### October 2022 * 1.1.7 * support ixnetwork version 9.20.2206.84 (9.20 Update-3) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/availablehardware/chassis/card/aggregation/aggregation.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/availablehardware/chassis/card/aggregation/aggregation.py index afd3a6b69..a41141012 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/availablehardware/chassis/card/aggregation/aggregation.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/availablehardware/chassis/card/aggregation/aggregation.py @@ -72,7 +72,9 @@ class Aggregation(Base): "krakenTwoByOneHundredGigFanOut", "krakenFourByFiftyGigFanOut", "aresOneOneByFourHundredGigNonFanOut", + "aresOneOneByFourHundredGigMacSecNonFanOut", "aresOneTwoByTwoHundredGigFanOut", + "aresOneTwoByTwoHundredGigMacSecFanOut", "aresOneFourByOneHundredGigFanOut", "aresOneFourByOneHundredGigMacSecFanOut", "aresOneEightByFiftyGigFanOut", @@ -85,6 +87,7 @@ class Aggregation(Base): "novus5GOneByTwentyFiveGigNonFanOut", "novus5GOneByFiftyGigNonFanOut", "novus5GOneByHundredGigNonFanOut", + "novus5GOneByHundredGigNonFanOutHighStream", "starTwoByFourHundredGigNonFannedOutPAM4", "starFourByTwoHundredGigFannedOutPAM4", "starEightByHundredGigFannedOutPAM4", @@ -94,11 +97,32 @@ class Aggregation(Base): "starFourByFortyGigFannedOutNRZ", "starSixteenByTwentyFiveGigFannedOutNRZ", "starSixteenByTenGigFannedOutNRZ", + "starFourByHundredGigFannedOutPAM4HalfDensityHighStream", + "starEightByFiftyGigFannedOutPAM4HalfDensityHighStream", + "starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream", + "starEightByTenGigFannedOutNRZHalfDensityHighStream", "novusHundredGigNonFanOutHighStream", "novusFourByTwentyFiveGigNonFanOutHighStream", "novusTwoByFiftyGigNonFanOutHighStream", "novusOneByFortyGigNonFanOutHighStream", "novusFourByTenGigNonFanOutHighStream", + "ravenEightByHundredGigFannedOutPAM4", + "ravenFourByTwoHundredGigFannedOutPAM4", + "ravenTwoByFourHundredGigFannedOutPAM4", + "ravenOneByEightHundredGigNonFannedOutPAM4", + "aresOneEightHundredQddCEightByHundredGigFannedOutPAM4", + "aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4", + "aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4", + "aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4", + "rangerHundredGig", + "rangerFiftyGig", + "rangerFourtyGig", + "rangerTwentyFiveGig", + "rangerTenGig", + "aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4", + "aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4", + "aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4", + "aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4", ], } @@ -131,7 +155,7 @@ def AvailableModes(self): """ Returns ------- - - list(str[normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream]): Gets the supported resource group modes. + - list(str[normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4]): Gets the supported resource group modes. """ return self._get_attribute(self._SDM_ATT_MAP["AvailableModes"]) @@ -141,7 +165,7 @@ def Mode(self): """ Returns ------- - - str(normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream): Resource Group mode. + - str(normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4): Resource Group mode. """ return self._get_attribute(self._SDM_ATT_MAP["Mode"]) @@ -166,7 +190,7 @@ def update(self, Mode=None): Args ---- - - Mode (str(normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream)): Resource Group mode. + - Mode (str(normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4)): Resource Group mode. Raises ------ @@ -180,7 +204,7 @@ def add(self, Mode=None): Args ---- - - Mode (str(normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream)): Resource Group mode. + - Mode (str(normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4)): Resource Group mode. Returns ------- @@ -211,8 +235,8 @@ def find( ---- - ActivePort (str(None | /api/v1/sessions/1/ixnetwork/availableHardware/chassis/card/port)): Deprecated. Use activePorts instead. - ActivePorts (list(str[None | /api/v1/sessions/1/ixnetwork/availableHardware/chassis/card/port])): All active ports from Resource Group. - - AvailableModes (list(str[normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream])): Gets the supported resource group modes. - - Mode (str(normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream)): Resource Group mode. + - AvailableModes (list(str[normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4])): Gets the supported resource group modes. + - Mode (str(normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4)): Resource Group mode. - ResourcePorts (list(str[None | /api/v1/sessions/1/ixnetwork/availableHardware/chassis/card/port])): All ports from Resource Group. Returns diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/availablehardware/chassis/card/card.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/availablehardware/chassis/card/card.py index 57aee798b..22a3b62a0 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/availablehardware/chassis/card/card.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/availablehardware/chassis/card/card.py @@ -75,7 +75,9 @@ class Card(Base): "krakenTwoByOneHundredGigFanOut", "krakenFourByFiftyGigFanOut", "aresOneOneByFourHundredGigNonFanOut", + "aresOneOneByFourHundredGigMacSecNonFanOut", "aresOneTwoByTwoHundredGigFanOut", + "aresOneTwoByTwoHundredGigMacSecFanOut", "aresOneFourByOneHundredGigFanOut", "aresOneFourByOneHundredGigMacSecFanOut", "aresOneEightByFiftyGigFanOut", @@ -88,6 +90,7 @@ class Card(Base): "novus5GOneByTwentyFiveGigNonFanOut", "novus5GOneByFiftyGigNonFanOut", "novus5GOneByHundredGigNonFanOut", + "novus5GOneByHundredGigNonFanOutHighStream", "starTwoByFourHundredGigNonFannedOutPAM4", "starFourByTwoHundredGigFannedOutPAM4", "starEightByHundredGigFannedOutPAM4", @@ -97,11 +100,32 @@ class Card(Base): "starFourByFortyGigFannedOutNRZ", "starSixteenByTwentyFiveGigFannedOutNRZ", "starSixteenByTenGigFannedOutNRZ", + "starFourByHundredGigFannedOutPAM4HalfDensityHighStream", + "starEightByFiftyGigFannedOutPAM4HalfDensityHighStream", + "starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream", + "starEightByTenGigFannedOutNRZHalfDensityHighStream", "novusHundredGigNonFanOutHighStream", "novusFourByTwentyFiveGigNonFanOutHighStream", "novusTwoByFiftyGigNonFanOutHighStream", "novusOneByFortyGigNonFanOutHighStream", "novusFourByTenGigNonFanOutHighStream", + "ravenEightByHundredGigFannedOutPAM4", + "ravenFourByTwoHundredGigFannedOutPAM4", + "ravenTwoByFourHundredGigFannedOutPAM4", + "ravenOneByEightHundredGigNonFannedOutPAM4", + "aresOneEightHundredQddCEightByHundredGigFannedOutPAM4", + "aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4", + "aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4", + "aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4", + "rangerHundredGig", + "rangerFiftyGig", + "rangerFourtyGig", + "rangerTwentyFiveGig", + "rangerTenGig", + "aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4", + "aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4", + "aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4", + "aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4", ], "portNamingScheme": ["v1", "v2"], } @@ -155,7 +179,7 @@ def AggregationMode(self): """ Returns ------- - - str(notSupported | mixed | normal | tenGigAggregation | fortyGigAggregation | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream): Gets or sets the aggregation mode. + - str(notSupported | mixed | normal | tenGigAggregation | fortyGigAggregation | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4): Gets or sets the aggregation mode. """ return self._get_attribute(self._SDM_ATT_MAP["AggregationMode"]) @@ -180,7 +204,7 @@ def AvailableModes(self): """ Returns ------- - - list(str[notSupported | mixed | normal | tenGigAggregation | fortyGigAggregation | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream]): Gets the supported port resource group modes on the card. + - list(str[notSupported | mixed | normal | tenGigAggregation | fortyGigAggregation | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4]): Gets the supported port resource group modes on the card. """ return self._get_attribute(self._SDM_ATT_MAP["AvailableModes"]) @@ -220,7 +244,7 @@ def update(self, AggregationMode=None): Args ---- - - AggregationMode (str(notSupported | mixed | normal | tenGigAggregation | fortyGigAggregation | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream)): Gets or sets the aggregation mode. + - AggregationMode (str(notSupported | mixed | normal | tenGigAggregation | fortyGigAggregation | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4)): Gets or sets the aggregation mode. Raises ------ @@ -234,7 +258,7 @@ def add(self, AggregationMode=None): Args ---- - - AggregationMode (str(notSupported | mixed | normal | tenGigAggregation | fortyGigAggregation | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream)): Gets or sets the aggregation mode. + - AggregationMode (str(notSupported | mixed | normal | tenGigAggregation | fortyGigAggregation | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4)): Gets or sets the aggregation mode. Returns ------- @@ -264,9 +288,9 @@ def find( Args ---- - - AggregationMode (str(notSupported | mixed | normal | tenGigAggregation | fortyGigAggregation | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream)): Gets or sets the aggregation mode. + - AggregationMode (str(notSupported | mixed | normal | tenGigAggregation | fortyGigAggregation | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4)): Gets or sets the aggregation mode. - AggregationSupported (bool): (read only) If true, indicates that the card is operating in resource group mode and not in normal mode - - AvailableModes (list(str[notSupported | mixed | normal | tenGigAggregation | fortyGigAggregation | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream])): Gets the supported port resource group modes on the card. + - AvailableModes (list(str[notSupported | mixed | normal | tenGigAggregation | fortyGigAggregation | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4])): Gets the supported port resource group modes on the card. - CardId (number): Identifier for the card on the chassis. - Description (str): Description of the card. - PortNamingScheme (str(v1 | v2)): diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/licensing/licensing.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/licensing/licensing.py index 6a12cf27a..1d574ca43 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/licensing/licensing.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/licensing/licensing.py @@ -35,17 +35,63 @@ class Licensing(Base): __slots__ = () _SDM_NAME = "licensing" _SDM_ATT_MAP = { + "AvailableTierOptions": "availableTierOptions", + "HwMode": "hwMode", + "HwTier": "hwTier", "LicensingServers": "licensingServers", "Mode": "mode", "Tier": "tier", + "VmMode": "vmMode", + "VmTier": "vmTier", } _SDM_ENUM_MAP = { + "hwMode": ["perpetual", "subscription"], "mode": ["aggregation", "mixed", "perpetual", "subscription"], + "vmMode": ["aggregation", "perpetual", "subscription"], } def __init__(self, parent, list_op=False): super(Licensing, self).__init__(parent, list_op) + @property + def AvailableTierOptions(self): + """ + Returns + ------- + - list(dict(arg1:str,arg2:list[str])): Gets list of available tier options for applicable license modes + """ + return self._get_attribute(self._SDM_ATT_MAP["AvailableTierOptions"]) + + @property + def HwMode(self): + # type: () -> str + """ + Returns + ------- + - str(perpetual | subscription): Set license mode to either perpetual mode or subscription mode. This setting is applicable for hardware ports only. + """ + return self._get_attribute(self._SDM_ATT_MAP["HwMode"]) + + @HwMode.setter + def HwMode(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["HwMode"], value) + + @property + def HwTier(self): + # type: () -> str + """ + Returns + ------- + - str: Set or get the tier level, by using the tier ID. This setting is applicable for hardware ports only. + """ + return self._get_attribute(self._SDM_ATT_MAP["HwTier"]) + + @HwTier.setter + def HwTier(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["HwTier"], value) + @property def LicensingServers(self): # type: () -> List[str] @@ -64,7 +110,7 @@ def LicensingServers(self, value): @property def Mode(self): # type: () -> str - """ + """DEPRECATED Returns ------- - str(aggregation | mixed | perpetual | subscription): Set license mode to either of perpetual,subscription,mixed or aggregation @@ -79,7 +125,7 @@ def Mode(self, value): @property def Tier(self): # type: () -> str - """ + """DEPRECATED Returns ------- - str: set or get the tier level, using the tier ID. @@ -91,15 +137,58 @@ def Tier(self, value): # type: (str) -> None self._set_attribute(self._SDM_ATT_MAP["Tier"], value) - def update(self, LicensingServers=None, Mode=None, Tier=None): - # type: (List[str], str, str) -> Licensing + @property + def VmMode(self): + # type: () -> str + """ + Returns + ------- + - str(aggregation | perpetual | subscription): Set license mode to either perpetual mode, subscription mode or aggregation mode. This setting is applicable for virtual ports only. + """ + return self._get_attribute(self._SDM_ATT_MAP["VmMode"]) + + @VmMode.setter + def VmMode(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["VmMode"], value) + + @property + def VmTier(self): + # type: () -> str + """ + Returns + ------- + - str: Set or get the tier level, by using the tier ID. This setting is applicable for virtual ports only. + """ + return self._get_attribute(self._SDM_ATT_MAP["VmTier"]) + + @VmTier.setter + def VmTier(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["VmTier"], value) + + def update( + self, + HwMode=None, + HwTier=None, + LicensingServers=None, + Mode=None, + Tier=None, + VmMode=None, + VmTier=None, + ): + # type: (str, str, List[str], str, str, str, str) -> Licensing """Updates licensing resource on the server. Args ---- + - HwMode (str(perpetual | subscription)): Set license mode to either perpetual mode or subscription mode. This setting is applicable for hardware ports only. + - HwTier (str): Set or get the tier level, by using the tier ID. This setting is applicable for hardware ports only. - LicensingServers (list(str)): List of license servers to use - Mode (str(aggregation | mixed | perpetual | subscription)): Set license mode to either of perpetual,subscription,mixed or aggregation - Tier (str): set or get the tier level, using the tier ID. + - VmMode (str(aggregation | perpetual | subscription)): Set license mode to either perpetual mode, subscription mode or aggregation mode. This setting is applicable for virtual ports only. + - VmTier (str): Set or get the tier level, by using the tier ID. This setting is applicable for virtual ports only. Raises ------ @@ -107,8 +196,17 @@ def update(self, LicensingServers=None, Mode=None, Tier=None): """ return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) - def find(self, LicensingServers=None, Mode=None, Tier=None): - # type: (List[str], str, str) -> Licensing + def find( + self, + AvailableTierOptions=None, + HwMode=None, + HwTier=None, + LicensingServers=None, + Mode=None, + Tier=None, + VmMode=None, + VmTier=None, + ): """Finds and retrieves licensing resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve licensing resources from the server. @@ -117,9 +215,14 @@ def find(self, LicensingServers=None, Mode=None, Tier=None): Args ---- + - AvailableTierOptions (list(dict(arg1:str,arg2:list[str]))): Gets list of available tier options for applicable license modes + - HwMode (str(perpetual | subscription)): Set license mode to either perpetual mode or subscription mode. This setting is applicable for hardware ports only. + - HwTier (str): Set or get the tier level, by using the tier ID. This setting is applicable for hardware ports only. - LicensingServers (list(str)): List of license servers to use - Mode (str(aggregation | mixed | perpetual | subscription)): Set license mode to either of perpetual,subscription,mixed or aggregation - Tier (str): set or get the tier level, using the tier ID. + - VmMode (str(aggregation | perpetual | subscription)): Set license mode to either perpetual mode, subscription mode or aggregation mode. This setting is applicable for virtual ports only. + - VmTier (str): Set or get the tier level, by using the tier ID. This setting is applicable for virtual ports only. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/preferences/preferences.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/preferences/preferences.py index 6c44b3ec6..ed3cfa6e3 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/preferences/preferences.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/preferences/preferences.py @@ -42,6 +42,8 @@ class Preferences(Base): "ConfigurationAtIxNetworkStartup": "configurationAtIxNetworkStartup", "ConnectPortsOnLoadConfig": "connectPortsOnLoadConfig", "DeleteDumpFilesOlderThan": "deleteDumpFilesOlderThan", + "DisableMinimizedScenario": "disableMinimizedScenario", + "DisableProtoSpecificConnectors": "disableProtoSpecificConnectors", "EnableAutoSave": "enableAutoSave", "EnableCloudTools": "enableCloudTools", "EnableDpdkForNewConfig": "enableDpdkForNewConfig", @@ -223,6 +225,36 @@ def DeleteDumpFilesOlderThan(self, value): # type: (int) -> None self._set_attribute(self._SDM_ATT_MAP["DeleteDumpFilesOlderThan"], value) + @property + def DisableMinimizedScenario(self): + # type: () -> bool + """ + Returns + ------- + - bool: When true, Device Group will be auto selected in Scenario on a new Topology creation + """ + return self._get_attribute(self._SDM_ATT_MAP["DisableMinimizedScenario"]) + + @DisableMinimizedScenario.setter + def DisableMinimizedScenario(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["DisableMinimizedScenario"], value) + + @property + def DisableProtoSpecificConnectors(self): + # type: () -> bool + """ + Returns + ------- + - bool: When true, Device Group will be auto selected in Scenario on a new Topology creation + """ + return self._get_attribute(self._SDM_ATT_MAP["DisableProtoSpecificConnectors"]) + + @DisableProtoSpecificConnectors.setter + def DisableProtoSpecificConnectors(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["DisableProtoSpecificConnectors"], value) + @property def EnableAutoSave(self): # type: () -> bool @@ -546,6 +578,8 @@ def update( ConfigurationAtIxNetworkStartup=None, ConnectPortsOnLoadConfig=None, DeleteDumpFilesOlderThan=None, + DisableMinimizedScenario=None, + DisableProtoSpecificConnectors=None, EnableAutoSave=None, EnableCloudTools=None, EnableDpdkForNewConfig=None, @@ -567,7 +601,7 @@ def update( SyslogPort=None, TransmitMode=None, ): - # type: (bool, int, str, str, str, bool, int, bool, bool, bool, bool, bool, bool, str, bool, bool, bool, str, List[str], str, str, bool, bool, bool, str, int, str) -> Preferences + # type: (bool, int, str, str, str, bool, int, bool, bool, bool, bool, bool, bool, bool, bool, str, bool, bool, bool, str, List[str], str, str, bool, bool, bool, str, int, str) -> Preferences """Updates preferences resource on the server. Args @@ -579,6 +613,8 @@ def update( - ConfigurationAtIxNetworkStartup (str(useEmptyConfiguration | useLastSavedConfiguration)): Controls which configuration to load when IxNetwork starts - ConnectPortsOnLoadConfig (bool): If true the application will connect the virtual ports to any assigned hardware ports when the configuration is loaded (Should be used only in IxNetwork Desktop App) - DeleteDumpFilesOlderThan (number): Dump Files older than the days set are deleted automatically. Need to restart IxNetwork for this option to take effect. + - DisableMinimizedScenario (bool): When true, Device Group will be auto selected in Scenario on a new Topology creation + - DisableProtoSpecificConnectors (bool): When true, Device Group will be auto selected in Scenario on a new Topology creation - EnableAutoSave (bool): If true,saves the configuration automatically. IxNetwork wont prompt to open the auto backup file when running in TCL Server mode. For performance reasons users additionally have to add a decimal registry key ForceAutoSave in Computer/HKEY_CURRENT_USER/Software/Ixia Communications/IxNetwork/Debug to do the auto save. Doesnt work yet on Linux - EnableCloudTools (bool): Controls whether Cloud Tool options will be enabled or not. This is related to learning MAC / IP address for a topology running on VM ports, deployed in AWS - EnableDpdkForNewConfig (bool): Sets the default DPDK enable/disable state when a new config is created. @@ -615,6 +651,8 @@ def find( ConfigurationAtIxNetworkStartup=None, ConnectPortsOnLoadConfig=None, DeleteDumpFilesOlderThan=None, + DisableMinimizedScenario=None, + DisableProtoSpecificConnectors=None, EnableAutoSave=None, EnableCloudTools=None, EnableDpdkForNewConfig=None, @@ -637,7 +675,7 @@ def find( SyslogPort=None, TransmitMode=None, ): - # type: (bool, int, str, str, str, bool, int, bool, bool, bool, bool, bool, bool, str, bool, bool, bool, str, List[str], List[str], str, str, bool, bool, bool, str, int, str) -> Preferences + # type: (bool, int, str, str, str, bool, int, bool, bool, bool, bool, bool, bool, bool, bool, str, bool, bool, bool, str, List[str], List[str], str, str, bool, bool, bool, str, int, str) -> Preferences """Finds and retrieves preferences resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve preferences resources from the server. @@ -653,6 +691,8 @@ def find( - ConfigurationAtIxNetworkStartup (str(useEmptyConfiguration | useLastSavedConfiguration)): Controls which configuration to load when IxNetwork starts - ConnectPortsOnLoadConfig (bool): If true the application will connect the virtual ports to any assigned hardware ports when the configuration is loaded (Should be used only in IxNetwork Desktop App) - DeleteDumpFilesOlderThan (number): Dump Files older than the days set are deleted automatically. Need to restart IxNetwork for this option to take effect. + - DisableMinimizedScenario (bool): When true, Device Group will be auto selected in Scenario on a new Topology creation + - DisableProtoSpecificConnectors (bool): When true, Device Group will be auto selected in Scenario on a new Topology creation - EnableAutoSave (bool): If true,saves the configuration automatically. IxNetwork wont prompt to open the auto backup file when running in TCL Server mode. For performance reasons users additionally have to add a decimal registry key ForceAutoSave in Computer/HKEY_CURRENT_USER/Software/Ixia Communications/IxNetwork/Debug to do the auto save. Doesnt work yet on Linux - EnableCloudTools (bool): Controls whether Cloud Tool options will be enabled or not. This is related to learning MAC / IP address for a topology running on VM ports, deployed in AWS - EnableDpdkForNewConfig (bool): Sets the default DPDK enable/disable state when a new config is created. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/preferences/statistics/statistics.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/preferences/statistics/statistics.py index 39519a26f..1f8b2d8e8 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/preferences/statistics/statistics.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/preferences/statistics/statistics.py @@ -36,6 +36,7 @@ class Statistics(Base): _SDM_NAME = "statistics" _SDM_ATT_MAP = { "ForceLegacyPortNameInStats": "forceLegacyPortNameInStats", + "GraphHistoryClockTime": "graphHistoryClockTime", "PersistenceMode": "persistenceMode", "SnapshotCSVMode": "snapshotCSVMode", "SnapshotCSVPath": "snapshotCSVPath", @@ -70,6 +71,21 @@ def ForceLegacyPortNameInStats(self, value): # type: (bool) -> None self._set_attribute(self._SDM_ATT_MAP["ForceLegacyPortNameInStats"], value) + @property + def GraphHistoryClockTime(self): + # type: () -> int + """ + Returns + ------- + - number: Tells us amount of time for which data is to be shown (in mint). Min:1, Max:30 + """ + return self._get_attribute(self._SDM_ATT_MAP["GraphHistoryClockTime"]) + + @GraphHistoryClockTime.setter + def GraphHistoryClockTime(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["GraphHistoryClockTime"], value) + @property def PersistenceMode(self): # type: () -> str @@ -118,16 +134,18 @@ def SnapshotCSVPath(self, value): def update( self, ForceLegacyPortNameInStats=None, + GraphHistoryClockTime=None, PersistenceMode=None, SnapshotCSVMode=None, SnapshotCSVPath=None, ): - # type: (bool, str, str, str) -> Statistics + # type: (bool, int, str, str, str) -> Statistics """Updates statistics resource on the server. Args ---- - ForceLegacyPortNameInStats (bool): When false, IxNetwork statistics show port name in format. When true, it is in format + - GraphHistoryClockTime (number): Tells us amount of time for which data is to be shown (in mint). Min:1, Max:30 - PersistenceMode (str(mixed | none | persistInBothLocations | persistInConfiguration | persistInUserSettings | preferencesNotSet)): Set the Persistence Mode: whether to store the data in user location or configuration or both/none - SnapshotCSVMode (str(appendCSVFile | newCSVFile | overwriteCSVFile)): Set the CSV Generation Mode - SnapshotCSVPath (str): Set the Snapshot CSV Path @@ -141,11 +159,12 @@ def update( def find( self, ForceLegacyPortNameInStats=None, + GraphHistoryClockTime=None, PersistenceMode=None, SnapshotCSVMode=None, SnapshotCSVPath=None, ): - # type: (bool, str, str, str) -> Statistics + # type: (bool, int, str, str, str) -> Statistics """Finds and retrieves statistics resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve statistics resources from the server. @@ -155,6 +174,7 @@ def find( Args ---- - ForceLegacyPortNameInStats (bool): When false, IxNetwork statistics show port name in format. When true, it is in format + - GraphHistoryClockTime (number): Tells us amount of time for which data is to be shown (in mint). Min:1, Max:30 - PersistenceMode (str(mixed | none | persistInBothLocations | persistInConfiguration | persistInUserSettings | preferencesNotSet)): Set the Persistence Mode: whether to store the data in user location or configuration or both/none - SnapshotCSVMode (str(appendCSVFile | newCSVFile | overwriteCSVFile)): Set the CSV Generation Mode - SnapshotCSVPath (str): Set the Snapshot CSV Path diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/advanced/advanced.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/advanced/advanced.py index 069556348..5c91d5749 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/advanced/advanced.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/advanced/advanced.py @@ -100,6 +100,26 @@ def DataStoreSettings(self): return self._properties.get("DataStoreSettings") return DataStoreSettings(self)._select() + @property + def EgressView(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.statistics.advanced.egressview.egressview.EgressView): An instance of the EgressView class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.statistics.advanced.egressview.egressview import ( + EgressView, + ) + + if len(self._object_properties) > 0: + if self._properties.get("EgressView", None) is not None: + return self._properties.get("EgressView") + return EgressView(self)._select() + @property def GuardRail(self): """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/advanced/egressview/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/advanced/egressview/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/advanced/egressview/egressview.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/advanced/egressview/egressview.py new file mode 100644 index 000000000..236e2a8c6 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/advanced/egressview/egressview.py @@ -0,0 +1,114 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class EgressView(Base): + """This node contains Egress View Settings. + The EgressView class encapsulates a required egressView resource which will be retrieved from the server every time the property is accessed. + """ + + __slots__ = () + _SDM_NAME = "egressView" + _SDM_ATT_MAP = { + "DefaultEgressView": "defaultEgressView", + } + _SDM_ENUM_MAP = { + "defaultEgressView": ["flatEgressView", "ingressEgressView"], + } + + def __init__(self, parent, list_op=False): + super(EgressView, self).__init__(parent, list_op) + + @property + def DefaultEgressView(self): + # type: () -> str + """ + Returns + ------- + - str(flatEgressView | ingressEgressView): Enables/Disables Guardrail. This setting will be only applied if there are no ports assigned. + """ + return self._get_attribute(self._SDM_ATT_MAP["DefaultEgressView"]) + + @DefaultEgressView.setter + def DefaultEgressView(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["DefaultEgressView"], value) + + def update(self, DefaultEgressView=None): + # type: (str) -> EgressView + """Updates egressView resource on the server. + + Args + ---- + - DefaultEgressView (str(flatEgressView | ingressEgressView)): Enables/Disables Guardrail. This setting will be only applied if there are no ports assigned. + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, DefaultEgressView=None): + # type: (str) -> EgressView + """Finds and retrieves egressView resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve egressView resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all egressView resources from the server. + + Args + ---- + - DefaultEgressView (str(flatEgressView | ingressEgressView)): Enables/Disables Guardrail. This setting will be only applied if there are no ports assigned. + + Returns + ------- + - self: This instance with matching egressView resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of egressView data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the egressView resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/reportgenerator/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/reportgenerator/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/reportgenerator/reportgenerator.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/reportgenerator/reportgenerator.py new file mode 100644 index 000000000..a32801b14 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/reportgenerator/reportgenerator.py @@ -0,0 +1,364 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class ReportGenerator(Base): + """This node contains Stats Report Generator Options and APIs. + The ReportGenerator class encapsulates a required reportGenerator resource which will be retrieved from the server every time the property is accessed. + """ + + __slots__ = () + _SDM_NAME = "reportGenerator" + _SDM_ATT_MAP = { + "DutHwVersion": "dutHwVersion", + "DutName": "dutName", + "DutSerialNo": "dutSerialNo", + "DutSwVersion": "dutSwVersion", + "IxNetworkVersion": "ixNetworkVersion", + "ReportType": "reportType", + "TestCategory": "testCategory", + "TestHighlights": "testHighlights", + "TestName": "testName", + "TestObjectives": "testObjectives", + "TesterName": "testerName", + } + _SDM_ENUM_MAP = { + "reportType": ["kNGPF", "kNone", "kTraffic", "kTrafficAndNGPF"], + } + + def __init__(self, parent, list_op=False): + super(ReportGenerator, self).__init__(parent, list_op) + + @property + def DutHwVersion(self): + # type: () -> str + """ + Returns + ------- + - str: + """ + return self._get_attribute(self._SDM_ATT_MAP["DutHwVersion"]) + + @DutHwVersion.setter + def DutHwVersion(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["DutHwVersion"], value) + + @property + def DutName(self): + # type: () -> str + """ + Returns + ------- + - str: + """ + return self._get_attribute(self._SDM_ATT_MAP["DutName"]) + + @DutName.setter + def DutName(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["DutName"], value) + + @property + def DutSerialNo(self): + # type: () -> str + """ + Returns + ------- + - str: + """ + return self._get_attribute(self._SDM_ATT_MAP["DutSerialNo"]) + + @DutSerialNo.setter + def DutSerialNo(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["DutSerialNo"], value) + + @property + def DutSwVersion(self): + # type: () -> str + """ + Returns + ------- + - str: + """ + return self._get_attribute(self._SDM_ATT_MAP["DutSwVersion"]) + + @DutSwVersion.setter + def DutSwVersion(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["DutSwVersion"], value) + + @property + def IxNetworkVersion(self): + # type: () -> str + """ + Returns + ------- + - str: + """ + return self._get_attribute(self._SDM_ATT_MAP["IxNetworkVersion"]) + + @property + def ReportType(self): + # type: () -> str + """ + Returns + ------- + - str(kNGPF | kNone | kTraffic | kTrafficAndNGPF): + """ + return self._get_attribute(self._SDM_ATT_MAP["ReportType"]) + + @ReportType.setter + def ReportType(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["ReportType"], value) + + @property + def TestCategory(self): + # type: () -> str + """ + Returns + ------- + - str: + """ + return self._get_attribute(self._SDM_ATT_MAP["TestCategory"]) + + @TestCategory.setter + def TestCategory(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["TestCategory"], value) + + @property + def TestHighlights(self): + # type: () -> str + """ + Returns + ------- + - str: + """ + return self._get_attribute(self._SDM_ATT_MAP["TestHighlights"]) + + @TestHighlights.setter + def TestHighlights(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["TestHighlights"], value) + + @property + def TestName(self): + # type: () -> str + """ + Returns + ------- + - str: + """ + return self._get_attribute(self._SDM_ATT_MAP["TestName"]) + + @TestName.setter + def TestName(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["TestName"], value) + + @property + def TestObjectives(self): + # type: () -> str + """ + Returns + ------- + - str: + """ + return self._get_attribute(self._SDM_ATT_MAP["TestObjectives"]) + + @TestObjectives.setter + def TestObjectives(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["TestObjectives"], value) + + @property + def TesterName(self): + # type: () -> str + """ + Returns + ------- + - str: + """ + return self._get_attribute(self._SDM_ATT_MAP["TesterName"]) + + @TesterName.setter + def TesterName(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["TesterName"], value) + + def update( + self, + DutHwVersion=None, + DutName=None, + DutSerialNo=None, + DutSwVersion=None, + ReportType=None, + TestCategory=None, + TestHighlights=None, + TestName=None, + TestObjectives=None, + TesterName=None, + ): + # type: (str, str, str, str, str, str, str, str, str, str) -> ReportGenerator + """Updates reportGenerator resource on the server. + + Args + ---- + - DutHwVersion (str): + - DutName (str): + - DutSerialNo (str): + - DutSwVersion (str): + - ReportType (str(kNGPF | kNone | kTraffic | kTrafficAndNGPF)): + - TestCategory (str): + - TestHighlights (str): + - TestName (str): + - TestObjectives (str): + - TesterName (str): + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find( + self, + DutHwVersion=None, + DutName=None, + DutSerialNo=None, + DutSwVersion=None, + IxNetworkVersion=None, + ReportType=None, + TestCategory=None, + TestHighlights=None, + TestName=None, + TestObjectives=None, + TesterName=None, + ): + # type: (str, str, str, str, str, str, str, str, str, str, str) -> ReportGenerator + """Finds and retrieves reportGenerator resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve reportGenerator resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all reportGenerator resources from the server. + + Args + ---- + - DutHwVersion (str): + - DutName (str): + - DutSerialNo (str): + - DutSwVersion (str): + - IxNetworkVersion (str): + - ReportType (str(kNGPF | kNone | kTraffic | kTrafficAndNGPF)): + - TestCategory (str): + - TestHighlights (str): + - TestName (str): + - TestObjectives (str): + - TesterName (str): + + Returns + ------- + - self: This instance with matching reportGenerator resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of reportGenerator data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the reportGenerator resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) + + def GenerateStatReportV2(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[str, None] + """Executes the generateStatReportV2 operation on the server. + + Generates Stat Report + + generateStatReportV2(async_operation=bool)string + ------------------------------------------------ + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns str: Either the location of the generated report file or error string in case of error + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self.href} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "generateStatReportV2", payload=payload, response_object=None + ) + + def GetCustomGraphData(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[str, None] + """Executes the getCustomGraphData operation on the server. + + Get custom graph data plotted over time + + getCustomGraphData(Arg2=string, async_operation=bool)string + ----------------------------------------------------------- + - Arg2 (str): view caption + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns str: Graph Data with column names and time stamp + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self.href} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "getCustomGraphData", payload=payload, response_object=None + ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/statistics.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/statistics.py index f49cd88e5..4b06fd12e 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/statistics.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/statistics/statistics.py @@ -83,6 +83,26 @@ def Datacenter(self): return self._properties.get("Datacenter") return Datacenter(self)._select() + @property + def ReportGenerator(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.statistics.reportgenerator.reportgenerator.ReportGenerator): An instance of the ReportGenerator class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.statistics.reportgenerator.reportgenerator import ( + ReportGenerator, + ) + + if len(self._object_properties) > 0: + if self._properties.get("ReportGenerator", None) is not None: + return self._properties.get("ReportGenerator") + return ReportGenerator(self)._select() + @property def StatFilter(self): """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/pcc/pcc_b9da1d5a5cf31906067f29bdfc78e860.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/pcc/pcc_b9da1d5a5cf31906067f29bdfc78e860.py new file mode 100644 index 000000000..4775a1f16 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/pcc/pcc_b9da1d5a5cf31906067f29bdfc78e860.py @@ -0,0 +1,491 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class Pcc(Base): + """PCC Port Specific Data + The Pcc class encapsulates a required pcc resource which will be retrieved from the server every time the property is accessed. + """ + + __slots__ = () + _SDM_NAME = "pcc" + _SDM_ATT_MAP = { + "BackupPCEOperationMode": "backupPCEOperationMode", + "BindingSIDDraftVersion": "bindingSIDDraftVersion", + "Count": "count", + "DescriptiveName": "descriptiveName", + "ErrorValueAttemptedSRv6WithoutCapabilityAdvertise": "errorValueAttemptedSRv6WithoutCapabilityAdvertise", + "ErrorValueInvalidSRv6SIDStructure": "errorValueInvalidSRv6SIDStructure", + "ErrorValueMissingSRv6PCECapSubTlv": "errorValueMissingSRv6PCECapSubTlv", + "ErrorValueRROContainsSRv6WithOtherSubobjects": "errorValueRROContainsSRv6WithOtherSubobjects", + "ErrorValueSIDAndNAIAbsentInSRv6RROSubobject": "errorValueSIDAndNAIAbsentInSRv6RROSubobject", + "LspDelegationDelay": "lspDelegationDelay", + "Name": "name", + "PathSetupTypeForSRv6": "pathSetupTypeForSRv6", + "PcePathComputationMode": "pcePathComputationMode", + "RowNames": "rowNames", + "Srv6EROSubobjectType": "srv6EROSubobjectType", + "Srv6PceCapabilitySubTLVType": "srv6PceCapabilitySubTLVType", + "Srv6RROSubobjectType": "srv6RROSubobjectType", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(Pcc, self).__init__(parent, list_op) + + @property + def StartRate(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.startrate.startrate_2bc83a4fb9730935e8259bdb40af2dc0.StartRate): An instance of the StartRate class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.startrate.startrate_2bc83a4fb9730935e8259bdb40af2dc0 import ( + StartRate, + ) + + if len(self._object_properties) > 0: + if self._properties.get("StartRate", None) is not None: + return self._properties.get("StartRate") + return StartRate(self)._select() + + @property + def StopRate(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.stoprate.stoprate_4ea9a1b38960d2b21012777131469a04.StopRate): An instance of the StopRate class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.stoprate.stoprate_4ea9a1b38960d2b21012777131469a04 import ( + StopRate, + ) + + if len(self._object_properties) > 0: + if self._properties.get("StopRate", None) is not None: + return self._properties.get("StopRate") + return StopRate(self)._select() + + @property + def BackupPCEOperationMode(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Backup PCE Operation Mode + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["BackupPCEOperationMode"]) + ) + + @property + def BindingSIDDraftVersion(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Depending on this field backward compatibility will be given. All draft versions before IETF draft will follow existing implementation. New IETF draft will be using new implementation and TLV structure. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["BindingSIDDraftVersion"]) + ) + + @property + def Count(self): + # type: () -> int + """ + Returns + ------- + - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["Count"]) + + @property + def DescriptiveName(self): + # type: () -> str + """ + Returns + ------- + - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + """ + return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) + + @property + def ErrorValueAttemptedSRv6WithoutCapabilityAdvertise(self): + # type: () -> int + """ + Returns + ------- + - number: Denotes the SRv6 Attempt w/o Capability Advertisement error value when PCEP Peer tries to send SRv6 ERO without SRv6 capability advertisement. + """ + return self._get_attribute( + self._SDM_ATT_MAP["ErrorValueAttemptedSRv6WithoutCapabilityAdvertise"] + ) + + @ErrorValueAttemptedSRv6WithoutCapabilityAdvertise.setter + def ErrorValueAttemptedSRv6WithoutCapabilityAdvertise(self, value): + # type: (int) -> None + self._set_attribute( + self._SDM_ATT_MAP["ErrorValueAttemptedSRv6WithoutCapabilityAdvertise"], + value, + ) + + @property + def ErrorValueInvalidSRv6SIDStructure(self): + # type: () -> int + """ + Returns + ------- + - number: This error value is sent when the sum of all four sizes advertised in the SID structure is larger than 128 bits. + """ + return self._get_attribute( + self._SDM_ATT_MAP["ErrorValueInvalidSRv6SIDStructure"] + ) + + @ErrorValueInvalidSRv6SIDStructure.setter + def ErrorValueInvalidSRv6SIDStructure(self, value): + # type: (int) -> None + self._set_attribute( + self._SDM_ATT_MAP["ErrorValueInvalidSRv6SIDStructure"], value + ) + + @property + def ErrorValueMissingSRv6PCECapSubTlv(self): + # type: () -> int + """ + Returns + ------- + - number: Denotes the Missing SRv6-PCE-CAPABILITY Sub-TLV error value when the SRv6-PCE-CAPABILITY sub-TLV is missing from the PATH-SETUP-TYPE-CAPABILITY TLV in the OPEN object. + """ + return self._get_attribute( + self._SDM_ATT_MAP["ErrorValueMissingSRv6PCECapSubTlv"] + ) + + @ErrorValueMissingSRv6PCECapSubTlv.setter + def ErrorValueMissingSRv6PCECapSubTlv(self, value): + # type: (int) -> None + self._set_attribute( + self._SDM_ATT_MAP["ErrorValueMissingSRv6PCECapSubTlv"], value + ) + + @property + def ErrorValueRROContainsSRv6WithOtherSubobjects(self): + # type: () -> int + """ + Returns + ------- + - number: This error value is sent when a PCE detects that the subobjects of an RRO are a combination of SRv6-RRO and other types of subobjects. + """ + return self._get_attribute( + self._SDM_ATT_MAP["ErrorValueRROContainsSRv6WithOtherSubobjects"] + ) + + @ErrorValueRROContainsSRv6WithOtherSubobjects.setter + def ErrorValueRROContainsSRv6WithOtherSubobjects(self, value): + # type: (int) -> None + self._set_attribute( + self._SDM_ATT_MAP["ErrorValueRROContainsSRv6WithOtherSubobjects"], value + ) + + @property + def ErrorValueSIDAndNAIAbsentInSRv6RROSubobject(self): + # type: () -> int + """ + Returns + ------- + - number: This error value is sent when a PCEP speaker receives an SRv6-RRO subobject where both SRv6 SID and NAI are absent. + """ + return self._get_attribute( + self._SDM_ATT_MAP["ErrorValueSIDAndNAIAbsentInSRv6RROSubobject"] + ) + + @ErrorValueSIDAndNAIAbsentInSRv6RROSubobject.setter + def ErrorValueSIDAndNAIAbsentInSRv6RROSubobject(self, value): + # type: (int) -> None + self._set_attribute( + self._SDM_ATT_MAP["ErrorValueSIDAndNAIAbsentInSRv6RROSubobject"], value + ) + + @property + def LspDelegationDelay(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Time in seconds before PCC distributes LSP delegation at startup. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["LspDelegationDelay"]) + ) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + @property + def PathSetupTypeForSRv6(self): + # type: () -> int + """ + Returns + ------- + - number: SRv6 Path Setup Type specifies PCE's capability of interpreting this type of Path. + """ + return self._get_attribute(self._SDM_ATT_MAP["PathSetupTypeForSRv6"]) + + @PathSetupTypeForSRv6.setter + def PathSetupTypeForSRv6(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["PathSetupTypeForSRv6"], value) + + @property + def PcePathComputationMode(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): PCE Path Computation Mode + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["PcePathComputationMode"]) + ) + + @property + def RowNames(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): Name of rows + """ + return self._get_attribute(self._SDM_ATT_MAP["RowNames"]) + + @property + def Srv6EROSubobjectType(self): + # type: () -> int + """ + Returns + ------- + - number: Code Point For SRv6 ERO Subobject Type. + """ + return self._get_attribute(self._SDM_ATT_MAP["Srv6EROSubobjectType"]) + + @Srv6EROSubobjectType.setter + def Srv6EROSubobjectType(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["Srv6EROSubobjectType"], value) + + @property + def Srv6PceCapabilitySubTLVType(self): + # type: () -> int + """ + Returns + ------- + - number: SRv6 PCE Capability Sub-TLV Type specifies PCE's capability of interpreting this type of sub-TLV. + """ + return self._get_attribute(self._SDM_ATT_MAP["Srv6PceCapabilitySubTLVType"]) + + @Srv6PceCapabilitySubTLVType.setter + def Srv6PceCapabilitySubTLVType(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["Srv6PceCapabilitySubTLVType"], value) + + @property + def Srv6RROSubobjectType(self): + # type: () -> int + """ + Returns + ------- + - number: Code Point For SRv6 RRO Subobject Type. + """ + return self._get_attribute(self._SDM_ATT_MAP["Srv6RROSubobjectType"]) + + @Srv6RROSubobjectType.setter + def Srv6RROSubobjectType(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["Srv6RROSubobjectType"], value) + + def update( + self, + ErrorValueAttemptedSRv6WithoutCapabilityAdvertise=None, + ErrorValueInvalidSRv6SIDStructure=None, + ErrorValueMissingSRv6PCECapSubTlv=None, + ErrorValueRROContainsSRv6WithOtherSubobjects=None, + ErrorValueSIDAndNAIAbsentInSRv6RROSubobject=None, + Name=None, + PathSetupTypeForSRv6=None, + Srv6EROSubobjectType=None, + Srv6PceCapabilitySubTLVType=None, + Srv6RROSubobjectType=None, + ): + # type: (int, int, int, int, int, str, int, int, int, int) -> Pcc + """Updates pcc resource on the server. + + This method has some named parameters with a type: obj (Multivalue). + The Multivalue class has documentation that details the possible values for those named parameters. + + Args + ---- + - ErrorValueAttemptedSRv6WithoutCapabilityAdvertise (number): Denotes the SRv6 Attempt w/o Capability Advertisement error value when PCEP Peer tries to send SRv6 ERO without SRv6 capability advertisement. + - ErrorValueInvalidSRv6SIDStructure (number): This error value is sent when the sum of all four sizes advertised in the SID structure is larger than 128 bits. + - ErrorValueMissingSRv6PCECapSubTlv (number): Denotes the Missing SRv6-PCE-CAPABILITY Sub-TLV error value when the SRv6-PCE-CAPABILITY sub-TLV is missing from the PATH-SETUP-TYPE-CAPABILITY TLV in the OPEN object. + - ErrorValueRROContainsSRv6WithOtherSubobjects (number): This error value is sent when a PCE detects that the subobjects of an RRO are a combination of SRv6-RRO and other types of subobjects. + - ErrorValueSIDAndNAIAbsentInSRv6RROSubobject (number): This error value is sent when a PCEP speaker receives an SRv6-RRO subobject where both SRv6 SID and NAI are absent. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - PathSetupTypeForSRv6 (number): SRv6 Path Setup Type specifies PCE's capability of interpreting this type of Path. + - Srv6EROSubobjectType (number): Code Point For SRv6 ERO Subobject Type. + - Srv6PceCapabilitySubTLVType (number): SRv6 PCE Capability Sub-TLV Type specifies PCE's capability of interpreting this type of sub-TLV. + - Srv6RROSubobjectType (number): Code Point For SRv6 RRO Subobject Type. + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find( + self, + Count=None, + DescriptiveName=None, + ErrorValueAttemptedSRv6WithoutCapabilityAdvertise=None, + ErrorValueInvalidSRv6SIDStructure=None, + ErrorValueMissingSRv6PCECapSubTlv=None, + ErrorValueRROContainsSRv6WithOtherSubobjects=None, + ErrorValueSIDAndNAIAbsentInSRv6RROSubobject=None, + Name=None, + PathSetupTypeForSRv6=None, + RowNames=None, + Srv6EROSubobjectType=None, + Srv6PceCapabilitySubTLVType=None, + Srv6RROSubobjectType=None, + ): + # type: (int, str, int, int, int, int, int, str, int, List[str], int, int, int) -> Pcc + """Finds and retrieves pcc resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve pcc resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all pcc resources from the server. + + Args + ---- + - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + - ErrorValueAttemptedSRv6WithoutCapabilityAdvertise (number): Denotes the SRv6 Attempt w/o Capability Advertisement error value when PCEP Peer tries to send SRv6 ERO without SRv6 capability advertisement. + - ErrorValueInvalidSRv6SIDStructure (number): This error value is sent when the sum of all four sizes advertised in the SID structure is larger than 128 bits. + - ErrorValueMissingSRv6PCECapSubTlv (number): Denotes the Missing SRv6-PCE-CAPABILITY Sub-TLV error value when the SRv6-PCE-CAPABILITY sub-TLV is missing from the PATH-SETUP-TYPE-CAPABILITY TLV in the OPEN object. + - ErrorValueRROContainsSRv6WithOtherSubobjects (number): This error value is sent when a PCE detects that the subobjects of an RRO are a combination of SRv6-RRO and other types of subobjects. + - ErrorValueSIDAndNAIAbsentInSRv6RROSubobject (number): This error value is sent when a PCEP speaker receives an SRv6-RRO subobject where both SRv6 SID and NAI are absent. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - PathSetupTypeForSRv6 (number): SRv6 Path Setup Type specifies PCE's capability of interpreting this type of Path. + - RowNames (list(str)): Name of rows + - Srv6EROSubobjectType (number): Code Point For SRv6 ERO Subobject Type. + - Srv6PceCapabilitySubTLVType (number): SRv6 PCE Capability Sub-TLV Type specifies PCE's capability of interpreting this type of sub-TLV. + - Srv6RROSubobjectType (number): Code Point For SRv6 RRO Subobject Type. + + Returns + ------- + - self: This instance with matching pcc resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of pcc data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the pcc resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) + + def get_device_ids( + self, + PortNames=None, + BackupPCEOperationMode=None, + BindingSIDDraftVersion=None, + LspDelegationDelay=None, + PcePathComputationMode=None, + ): + """Base class infrastructure that gets a list of pcc device ids encapsulated by this object. + + Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. + + Args + ---- + - PortNames (str): optional regex of port names + - BackupPCEOperationMode (str): optional regex of backupPCEOperationMode + - BindingSIDDraftVersion (str): optional regex of bindingSIDDraftVersion + - LspDelegationDelay (str): optional regex of lspDelegationDelay + - PcePathComputationMode (str): optional regex of pcePathComputationMode + + Returns + ------- + - list(int): A list of device ids that meets the regex criteria provided in the method parameters + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._get_ngpf_device_ids(locals()) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/pce/pce_01d903d1ebbc310362aec8b4e7dc8176.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/pce/pce_01d903d1ebbc310362aec8b4e7dc8176.py new file mode 100644 index 000000000..44bd16e74 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/pce/pce_01d903d1ebbc310362aec8b4e7dc8176.py @@ -0,0 +1,436 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class Pce(Base): + """PCE Port Specific Data + The Pce class encapsulates a required pce resource which will be retrieved from the server every time the property is accessed. + """ + + __slots__ = () + _SDM_NAME = "pce" + _SDM_ATT_MAP = { + "BindingSIDDraftVersion": "bindingSIDDraftVersion", + "Count": "count", + "DescriptiveName": "descriptiveName", + "ErrorValueAttemptedSRv6WithoutCapabilityAdvertise": "errorValueAttemptedSRv6WithoutCapabilityAdvertise", + "ErrorValueInvalidSRv6SIDStructure": "errorValueInvalidSRv6SIDStructure", + "ErrorValueMissingSRv6PCECapSubTlv": "errorValueMissingSRv6PCECapSubTlv", + "ErrorValueRROContainsSRv6WithOtherSubobjects": "errorValueRROContainsSRv6WithOtherSubobjects", + "ErrorValueSIDAndNAIAbsentInSRv6RROSubobject": "errorValueSIDAndNAIAbsentInSRv6RROSubobject", + "Name": "name", + "PathSetupTypeForSRv6": "pathSetupTypeForSRv6", + "RowNames": "rowNames", + "Srv6EROSubobjectType": "srv6EROSubobjectType", + "Srv6PceCapabilitySubTLVType": "srv6PceCapabilitySubTLVType", + "Srv6RROSubobjectType": "srv6RROSubobjectType", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(Pce, self).__init__(parent, list_op) + + @property + def StartRate(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.startrate.startrate_2bc83a4fb9730935e8259bdb40af2dc0.StartRate): An instance of the StartRate class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.startrate.startrate_2bc83a4fb9730935e8259bdb40af2dc0 import ( + StartRate, + ) + + if len(self._object_properties) > 0: + if self._properties.get("StartRate", None) is not None: + return self._properties.get("StartRate") + return StartRate(self)._select() + + @property + def StopRate(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.stoprate.stoprate_4ea9a1b38960d2b21012777131469a04.StopRate): An instance of the StopRate class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.stoprate.stoprate_4ea9a1b38960d2b21012777131469a04 import ( + StopRate, + ) + + if len(self._object_properties) > 0: + if self._properties.get("StopRate", None) is not None: + return self._properties.get("StopRate") + return StopRate(self)._select() + + @property + def BindingSIDDraftVersion(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Depending on this field backward compatibility will be given. All draft versions before IETF draft will follow existing implementation. New IETF draft will be using new implementation and TLV structure. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["BindingSIDDraftVersion"]) + ) + + @property + def Count(self): + # type: () -> int + """ + Returns + ------- + - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["Count"]) + + @property + def DescriptiveName(self): + # type: () -> str + """ + Returns + ------- + - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + """ + return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) + + @property + def ErrorValueAttemptedSRv6WithoutCapabilityAdvertise(self): + # type: () -> int + """ + Returns + ------- + - number: Denotes the SRv6 Attempt w/o Capability Advertisement error value when PCEP Peer tries to send SRv6 ERO without SRv6 capability advertisement. + """ + return self._get_attribute( + self._SDM_ATT_MAP["ErrorValueAttemptedSRv6WithoutCapabilityAdvertise"] + ) + + @ErrorValueAttemptedSRv6WithoutCapabilityAdvertise.setter + def ErrorValueAttemptedSRv6WithoutCapabilityAdvertise(self, value): + # type: (int) -> None + self._set_attribute( + self._SDM_ATT_MAP["ErrorValueAttemptedSRv6WithoutCapabilityAdvertise"], + value, + ) + + @property + def ErrorValueInvalidSRv6SIDStructure(self): + # type: () -> int + """ + Returns + ------- + - number: This error value is sent when the sum of all four sizes advertised in the SID structure is larger than 128 bits. + """ + return self._get_attribute( + self._SDM_ATT_MAP["ErrorValueInvalidSRv6SIDStructure"] + ) + + @ErrorValueInvalidSRv6SIDStructure.setter + def ErrorValueInvalidSRv6SIDStructure(self, value): + # type: (int) -> None + self._set_attribute( + self._SDM_ATT_MAP["ErrorValueInvalidSRv6SIDStructure"], value + ) + + @property + def ErrorValueMissingSRv6PCECapSubTlv(self): + # type: () -> int + """ + Returns + ------- + - number: Denotes the Missing SRv6-PCE-CAPABILITY Sub-TLV error value when the SRv6-PCE-CAPABILITY sub-TLV is missing from the PATH-SETUP-TYPE-CAPABILITY TLV in the OPEN object. + """ + return self._get_attribute( + self._SDM_ATT_MAP["ErrorValueMissingSRv6PCECapSubTlv"] + ) + + @ErrorValueMissingSRv6PCECapSubTlv.setter + def ErrorValueMissingSRv6PCECapSubTlv(self, value): + # type: (int) -> None + self._set_attribute( + self._SDM_ATT_MAP["ErrorValueMissingSRv6PCECapSubTlv"], value + ) + + @property + def ErrorValueRROContainsSRv6WithOtherSubobjects(self): + # type: () -> int + """ + Returns + ------- + - number: This error value is sent when a PCE detects that the subobjects of an RRO are a combination of SRv6-RRO and other types of subobjects. + """ + return self._get_attribute( + self._SDM_ATT_MAP["ErrorValueRROContainsSRv6WithOtherSubobjects"] + ) + + @ErrorValueRROContainsSRv6WithOtherSubobjects.setter + def ErrorValueRROContainsSRv6WithOtherSubobjects(self, value): + # type: (int) -> None + self._set_attribute( + self._SDM_ATT_MAP["ErrorValueRROContainsSRv6WithOtherSubobjects"], value + ) + + @property + def ErrorValueSIDAndNAIAbsentInSRv6RROSubobject(self): + # type: () -> int + """ + Returns + ------- + - number: This error value is sent when a PCEP speaker receives an SRv6-RRO subobject where both SRv6 SID and NAI are absent. + """ + return self._get_attribute( + self._SDM_ATT_MAP["ErrorValueSIDAndNAIAbsentInSRv6RROSubobject"] + ) + + @ErrorValueSIDAndNAIAbsentInSRv6RROSubobject.setter + def ErrorValueSIDAndNAIAbsentInSRv6RROSubobject(self, value): + # type: (int) -> None + self._set_attribute( + self._SDM_ATT_MAP["ErrorValueSIDAndNAIAbsentInSRv6RROSubobject"], value + ) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + @property + def PathSetupTypeForSRv6(self): + # type: () -> int + """ + Returns + ------- + - number: SRv6 Path Setup Type specifies PCE's capability of interpreting this type of Path. + """ + return self._get_attribute(self._SDM_ATT_MAP["PathSetupTypeForSRv6"]) + + @PathSetupTypeForSRv6.setter + def PathSetupTypeForSRv6(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["PathSetupTypeForSRv6"], value) + + @property + def RowNames(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): Name of rows + """ + return self._get_attribute(self._SDM_ATT_MAP["RowNames"]) + + @property + def Srv6EROSubobjectType(self): + # type: () -> int + """ + Returns + ------- + - number: Code Point For SRv6 ERO Subobject Type. + """ + return self._get_attribute(self._SDM_ATT_MAP["Srv6EROSubobjectType"]) + + @Srv6EROSubobjectType.setter + def Srv6EROSubobjectType(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["Srv6EROSubobjectType"], value) + + @property + def Srv6PceCapabilitySubTLVType(self): + # type: () -> int + """ + Returns + ------- + - number: SRv6 PCE Capability Sub-TLV Type specifies PCE's capability of interpreting this type of sub-TLV. + """ + return self._get_attribute(self._SDM_ATT_MAP["Srv6PceCapabilitySubTLVType"]) + + @Srv6PceCapabilitySubTLVType.setter + def Srv6PceCapabilitySubTLVType(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["Srv6PceCapabilitySubTLVType"], value) + + @property + def Srv6RROSubobjectType(self): + # type: () -> int + """ + Returns + ------- + - number: Code Point For SRv6 RRO Subobject Type. + """ + return self._get_attribute(self._SDM_ATT_MAP["Srv6RROSubobjectType"]) + + @Srv6RROSubobjectType.setter + def Srv6RROSubobjectType(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["Srv6RROSubobjectType"], value) + + def update( + self, + ErrorValueAttemptedSRv6WithoutCapabilityAdvertise=None, + ErrorValueInvalidSRv6SIDStructure=None, + ErrorValueMissingSRv6PCECapSubTlv=None, + ErrorValueRROContainsSRv6WithOtherSubobjects=None, + ErrorValueSIDAndNAIAbsentInSRv6RROSubobject=None, + Name=None, + PathSetupTypeForSRv6=None, + Srv6EROSubobjectType=None, + Srv6PceCapabilitySubTLVType=None, + Srv6RROSubobjectType=None, + ): + # type: (int, int, int, int, int, str, int, int, int, int) -> Pce + """Updates pce resource on the server. + + This method has some named parameters with a type: obj (Multivalue). + The Multivalue class has documentation that details the possible values for those named parameters. + + Args + ---- + - ErrorValueAttemptedSRv6WithoutCapabilityAdvertise (number): Denotes the SRv6 Attempt w/o Capability Advertisement error value when PCEP Peer tries to send SRv6 ERO without SRv6 capability advertisement. + - ErrorValueInvalidSRv6SIDStructure (number): This error value is sent when the sum of all four sizes advertised in the SID structure is larger than 128 bits. + - ErrorValueMissingSRv6PCECapSubTlv (number): Denotes the Missing SRv6-PCE-CAPABILITY Sub-TLV error value when the SRv6-PCE-CAPABILITY sub-TLV is missing from the PATH-SETUP-TYPE-CAPABILITY TLV in the OPEN object. + - ErrorValueRROContainsSRv6WithOtherSubobjects (number): This error value is sent when a PCE detects that the subobjects of an RRO are a combination of SRv6-RRO and other types of subobjects. + - ErrorValueSIDAndNAIAbsentInSRv6RROSubobject (number): This error value is sent when a PCEP speaker receives an SRv6-RRO subobject where both SRv6 SID and NAI are absent. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - PathSetupTypeForSRv6 (number): SRv6 Path Setup Type specifies PCE's capability of interpreting this type of Path. + - Srv6EROSubobjectType (number): Code Point For SRv6 ERO Subobject Type. + - Srv6PceCapabilitySubTLVType (number): SRv6 PCE Capability Sub-TLV Type specifies PCE's capability of interpreting this type of sub-TLV. + - Srv6RROSubobjectType (number): Code Point For SRv6 RRO Subobject Type. + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find( + self, + Count=None, + DescriptiveName=None, + ErrorValueAttemptedSRv6WithoutCapabilityAdvertise=None, + ErrorValueInvalidSRv6SIDStructure=None, + ErrorValueMissingSRv6PCECapSubTlv=None, + ErrorValueRROContainsSRv6WithOtherSubobjects=None, + ErrorValueSIDAndNAIAbsentInSRv6RROSubobject=None, + Name=None, + PathSetupTypeForSRv6=None, + RowNames=None, + Srv6EROSubobjectType=None, + Srv6PceCapabilitySubTLVType=None, + Srv6RROSubobjectType=None, + ): + # type: (int, str, int, int, int, int, int, str, int, List[str], int, int, int) -> Pce + """Finds and retrieves pce resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve pce resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all pce resources from the server. + + Args + ---- + - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + - ErrorValueAttemptedSRv6WithoutCapabilityAdvertise (number): Denotes the SRv6 Attempt w/o Capability Advertisement error value when PCEP Peer tries to send SRv6 ERO without SRv6 capability advertisement. + - ErrorValueInvalidSRv6SIDStructure (number): This error value is sent when the sum of all four sizes advertised in the SID structure is larger than 128 bits. + - ErrorValueMissingSRv6PCECapSubTlv (number): Denotes the Missing SRv6-PCE-CAPABILITY Sub-TLV error value when the SRv6-PCE-CAPABILITY sub-TLV is missing from the PATH-SETUP-TYPE-CAPABILITY TLV in the OPEN object. + - ErrorValueRROContainsSRv6WithOtherSubobjects (number): This error value is sent when a PCE detects that the subobjects of an RRO are a combination of SRv6-RRO and other types of subobjects. + - ErrorValueSIDAndNAIAbsentInSRv6RROSubobject (number): This error value is sent when a PCEP speaker receives an SRv6-RRO subobject where both SRv6 SID and NAI are absent. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - PathSetupTypeForSRv6 (number): SRv6 Path Setup Type specifies PCE's capability of interpreting this type of Path. + - RowNames (list(str)): Name of rows + - Srv6EROSubobjectType (number): Code Point For SRv6 ERO Subobject Type. + - Srv6PceCapabilitySubTLVType (number): SRv6 PCE Capability Sub-TLV Type specifies PCE's capability of interpreting this type of sub-TLV. + - Srv6RROSubobjectType (number): Code Point For SRv6 RRO Subobject Type. + + Returns + ------- + - self: This instance with matching pce resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of pce data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the pce resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) + + def get_device_ids(self, PortNames=None, BindingSIDDraftVersion=None): + """Base class infrastructure that gets a list of pce device ids encapsulated by this object. + + Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. + + Args + ---- + - PortNames (str): optional regex of port names + - BindingSIDDraftVersion (str): optional regex of bindingSIDDraftVersion + + Returns + ------- + - list(int): A list of device ids that meets the regex criteria provided in the method parameters + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._get_ngpf_device_ids(locals()) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/topology_678a8dc80c9b4b2b5c741072eab4305d.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/topology_678a8dc80c9b4b2b5c741072eab4305d.py index 0181a9652..b759cc901 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/topology_678a8dc80c9b4b2b5c741072eab4305d.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/topology_678a8dc80c9b4b2b5c741072eab4305d.py @@ -1265,13 +1265,13 @@ def Pcc(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.pcc.pcc_91c1343cca1ebf407382f361cdaac3e7.Pcc): An instance of the Pcc class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.pcc.pcc_b9da1d5a5cf31906067f29bdfc78e860.Pcc): An instance of the Pcc class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.pcc.pcc_91c1343cca1ebf407382f361cdaac3e7 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.pcc.pcc_b9da1d5a5cf31906067f29bdfc78e860 import ( Pcc, ) @@ -1285,13 +1285,13 @@ def Pce(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.pce.pce_5defd13c57ea406c73fd4b2cb010a30f.Pce): An instance of the Pce class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.pce.pce_01d903d1ebbc310362aec8b4e7dc8176.Pce): An instance of the Pce class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.pce.pce_5defd13c57ea406c73fd4b2cb010a30f import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.pce.pce_01d903d1ebbc310362aec8b4e7dc8176 import ( Pce, ) @@ -1460,6 +1460,46 @@ def StaticMacsec(self): return self._properties.get("StaticMacsec") return StaticMacsec(self)._select() + @property + def TwampIpv4(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.twampipv4.twampipv4_83456029c1debac8b6bdcdd43fd80f00.TwampIpv4): An instance of the TwampIpv4 class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.twampipv4.twampipv4_83456029c1debac8b6bdcdd43fd80f00 import ( + TwampIpv4, + ) + + if len(self._object_properties) > 0: + if self._properties.get("TwampIpv4", None) is not None: + return self._properties.get("TwampIpv4") + return TwampIpv4(self)._select() + + @property + def TwampIpv6(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.twampipv6.twampipv6_38ebcf9adafea940a522a0879aa08fb0.TwampIpv6): An instance of the TwampIpv6 class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.twampipv6.twampipv6_38ebcf9adafea940a522a0879aa08fb0 import ( + TwampIpv6, + ) + + if len(self._object_properties) > 0: + if self._properties.get("TwampIpv6", None) is not None: + return self._properties.get("TwampIpv6") + return TwampIpv6(self)._select() + @property def UpGroupInfo(self): """ @@ -1792,6 +1832,31 @@ def FetchAndUpdateConfigFromCloud(self, *args, **kwargs): "fetchAndUpdateConfigFromCloud", payload=payload, response_object=None ) + def FetchDeviceGroupCount(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[int, None] + """Executes the fetchDeviceGroupCount operation on the server. + + Get Device Group Count for the Entire Scenario + + fetchDeviceGroupCount(async_operation=bool)number + ------------------------------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns number: Device Group Count for the Entire Scenario + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self.href} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "fetchDeviceGroupCount", payload=payload, response_object=None + ) + def FetchScenarioObjectsShortenedNames(self, *args, **kwargs): # type: (*Any, **Any) -> Union[str, None] """Executes the fetchScenarioObjectsShortenedNames operation on the server. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/twampipv4/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/twampipv4/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/twampipv4/twampipv4_83456029c1debac8b6bdcdd43fd80f00.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/twampipv4/twampipv4_83456029c1debac8b6bdcdd43fd80f00.py new file mode 100644 index 000000000..fc253126a --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/twampipv4/twampipv4_83456029c1debac8b6bdcdd43fd80f00.py @@ -0,0 +1,148 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class TwampIpv4(Base): + """ + The TwampIpv4 class encapsulates a required twampIpv4 resource which will be retrieved from the server every time the property is accessed. + """ + + __slots__ = () + _SDM_NAME = "twampIpv4" + _SDM_ATT_MAP = { + "Count": "count", + "DescriptiveName": "descriptiveName", + "Name": "name", + "RowNames": "rowNames", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(TwampIpv4, self).__init__(parent, list_op) + + @property + def Count(self): + # type: () -> int + """ + Returns + ------- + - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["Count"]) + + @property + def DescriptiveName(self): + # type: () -> str + """ + Returns + ------- + - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + """ + return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + @property + def RowNames(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): Name of rows + """ + return self._get_attribute(self._SDM_ATT_MAP["RowNames"]) + + def update(self, Name=None): + # type: (str) -> TwampIpv4 + """Updates twampIpv4 resource on the server. + + Args + ---- + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Count=None, DescriptiveName=None, Name=None, RowNames=None): + # type: (int, str, str, List[str]) -> TwampIpv4 + """Finds and retrieves twampIpv4 resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve twampIpv4 resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all twampIpv4 resources from the server. + + Args + ---- + - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - RowNames (list(str)): Name of rows + + Returns + ------- + - self: This instance with matching twampIpv4 resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of twampIpv4 data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the twampIpv4 resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/twampipv6/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/twampipv6/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/twampipv6/twampipv6_38ebcf9adafea940a522a0879aa08fb0.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/twampipv6/twampipv6_38ebcf9adafea940a522a0879aa08fb0.py new file mode 100644 index 000000000..b58795c7d --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/twampipv6/twampipv6_38ebcf9adafea940a522a0879aa08fb0.py @@ -0,0 +1,148 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class TwampIpv6(Base): + """ + The TwampIpv6 class encapsulates a required twampIpv6 resource which will be retrieved from the server every time the property is accessed. + """ + + __slots__ = () + _SDM_NAME = "twampIpv6" + _SDM_ATT_MAP = { + "Count": "count", + "DescriptiveName": "descriptiveName", + "Name": "name", + "RowNames": "rowNames", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(TwampIpv6, self).__init__(parent, list_op) + + @property + def Count(self): + # type: () -> int + """ + Returns + ------- + - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["Count"]) + + @property + def DescriptiveName(self): + # type: () -> str + """ + Returns + ------- + - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + """ + return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + @property + def RowNames(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): Name of rows + """ + return self._get_attribute(self._SDM_ATT_MAP["RowNames"]) + + def update(self, Name=None): + # type: (str) -> TwampIpv6 + """Updates twampIpv6 resource on the server. + + Args + ---- + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Count=None, DescriptiveName=None, Name=None, RowNames=None): + # type: (int, str, str, List[str]) -> TwampIpv6 + """Finds and retrieves twampIpv6 resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve twampIpv6 resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all twampIpv6 resources from the server. + + Args + ---- + - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - RowNames (list(str)): Name of rows + + Returns + ------- + - self: This instance with matching twampIpv6 resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of twampIpv6 data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the twampIpv6 resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/ixnetwork.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/ixnetwork.py index 6a8cc3160..8903b5bb7 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/ixnetwork.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/ixnetwork.py @@ -316,6 +316,30 @@ def Watch(self): return self._properties.get("Watch") return Watch(self)._select() + def AddOfflinePorts(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the addOfflinePorts operation on the server. + + Add Ports (offline) + + addOfflinePorts(Arg1=number, Arg2=string, async_operation=bool) + --------------------------------------------------------------- + - Arg1 (number): Number of Ports to add (1-100) + - Arg2 (str): Type of Ports to add, 'Ethernet' by default + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {} + for i in range(len(args)): + payload["Arg%s" % (i + 1)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("addOfflinePorts", payload=payload, response_object=None) + def ApplyITWizardConfiguration(self, *args, **kwargs): # type: (*Any, **Any) -> None """Executes the applyITWizardConfiguration operation on the server. @@ -679,6 +703,36 @@ def CollectLogs(self, *args, **kwargs): payload[item[0]] = item[1] return self._execute("collectLogs", payload=payload, response_object=None) + def ConfigureCustomGraphWebUI(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the configureCustomGraphWebUI operation on the server. + + Creates Custom Graph WebUI View + + configureCustomGraphWebUI(Operation=string, ViewCaption=string, RowIdentifier=list, ColumnIdentifier=list, CustomGraphCaption=string, ExtraPayload=list, async_operation=bool) + ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ + - Operation (str): The Operation to perform + - ViewCaption (str): View Caption + - RowIdentifier (list(str)): Row Identifier + - ColumnIdentifier (list(str)): Column Identifier + - CustomGraphCaption (str): Custom Graph Web UI Caption + - ExtraPayload (list(str)): Extra Payload + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {} + for i in range(len(args)): + payload["Arg%s" % (i + 1)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "configureCustomGraphWebUI", payload=payload, response_object=None + ) + def ConnectCardById(self, *args, **kwargs): # type: (*Any, **Any) -> Union[int, None] """Executes the connectCardById operation on the server. @@ -774,6 +828,32 @@ def CopyFile(self, *args, **kwargs): payload[item[0]] = item[1] return self._execute("copyFile", payload=payload, response_object=None) + def CreateFDWebUIView(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the createFDWebUIView operation on the server. + + Creates Flow Detective WebUI View + + createFDWebUIView(TrafficItems=list, RxPorts=list, FlowState=enum, FlowPerformers=enum, async_operation=bool) + ------------------------------------------------------------------------------------------------------------- + - TrafficItems (list(str)): A list of Traffic Items. + - RxPorts (list(str)): A list of Ports. + - FlowState (str(kShowAllFlows | kShowOnlyDeadFlows | kShowOnlyLiveFlows)): The Flow State + - FlowPerformers (str(kBestCondition | kWorstCondition)): Best/Worst Performers + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {} + for i in range(len(args)): + payload["Arg%s" % (i + 1)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("createFDWebUIView", payload=payload, response_object=None) + def DisconnectCardById(self, *args, **kwargs): # type: (*Any, **Any) -> Union[int, None] """Executes the disconnectCardById operation on the server. @@ -978,6 +1058,56 @@ def GetAllPorts(self, *args, **kwargs): payload[item[0]] = item[1] return self._execute("getAllPorts", payload=payload, response_object=None) + def GetAvailableGlobalStatsActions(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[str, None] + """Executes the getAvailableGlobalStatsActions operation on the server. + + The command to get the available global statistics actions. + + getAvailableGlobalStatsActions(async_operation=bool)string + ---------------------------------------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns str: A string containing the list of all available global statistics actions. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {} + for i in range(len(args)): + payload["Arg%s" % (i + 1)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "getAvailableGlobalStatsActions", payload=payload, response_object=None + ) + + def GetAvailableOfflinePortTypes(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[str, None] + """Executes the getAvailableOfflinePortTypes operation on the server. + + gets all Available Offline Port Types + + getAvailableOfflinePortTypes(async_operation=bool)string + -------------------------------------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns str: + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {} + for i in range(len(args)): + payload["Arg%s" % (i + 1)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "getAvailableOfflinePortTypes", payload=payload, response_object=None + ) + def GetAvailableProtocolStats(self, *args, **kwargs): # type: (*Any, **Any) -> Union[str, None] """Executes the getAvailableProtocolStats operation on the server. @@ -1085,12 +1215,12 @@ def GetChassisMode(self, *args, **kwargs): # type: (*Any, **Any) -> Union[str, None] """Executes the getChassisMode operation on the server. - Get current chassis mode(default/highRoute/unknown) for the default chassis. + Get current chassis mode(default/highRoute/ionvsFdb/unknown) for the default chassis. getChassisMode(async_operation=bool)enum ---------------------------------------- - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - - Returns str(default\~highRoute\~unknown): current mode of chassis(default/highRoute/unknown). + - Returns str(default\~highRoute\~ionvsFdb\~unknown): current mode of chassis(default/highRoute/ionvsFdb/unknown). Raises ------ @@ -1227,6 +1357,31 @@ def GetDefaultSnapshotSettings(self, *args, **kwargs): "GetDefaultSnapshotSettings", payload=payload, response_object=None ) + def GetFDViewEnabledObjects(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[str, None] + """Executes the getFDViewEnabledObjects operation on the server. + + Fetches TI and Ports that are enabled for the FD WebUI Stat view + + getFDViewEnabledObjects(async_operation=bool)string + --------------------------------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns str: + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {} + for i in range(len(args)): + payload["Arg%s" % (i + 1)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "getFDViewEnabledObjects", payload=payload, response_object=None + ) + def GetInstalledSlotLicenseCount(self, *args, **kwargs): # type: (*Any, **Any) -> Union[int, None] """Executes the getInstalledSlotLicenseCount operation on the server. @@ -1506,6 +1661,32 @@ def GetSlotLicenseInUse(self, *args, **kwargs): "getSlotLicenseInUse", payload=payload, response_object=None ) + def GetSystemResources(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[str, None] + """Executes the getSystemResources operation on the server. + + This command collects system resources include System Memory and Disk Usage and all processes running + + getSystemResources(Arg1=bool, async_operation=bool)string + --------------------------------------------------------- + - Arg1 (bool): Whether we want to see system processes in the output list. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns str: + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {} + for i in range(len(args)): + payload["Arg%s" % (i + 1)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "getSystemResources", payload=payload, response_object=None + ) + def GetTapSettings(self, *args, **kwargs): # type: (*Any, **Any) -> None """Executes the getTapSettings operation on the server. @@ -2020,6 +2201,31 @@ def SaveConfig(self, *args, **kwargs): payload[item[0]] = item[1] return self._execute("saveConfig", payload=payload, response_object=None) + def SaveSystemResources(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[str, None] + """Executes the saveSystemResources operation on the server. + + This command collects system resources include System Memory and Disk Usage and all processes running and saves into a csv + + saveSystemResources(async_operation=bool)string + ----------------------------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns str: Returns the save file path. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {} + for i in range(len(args)): + payload["Arg%s" % (i + 1)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "saveSystemResources", payload=payload, response_object=None + ) + def Scriptgen(self, *args, **kwargs): # type: (*Any, **Any) -> Union[str, None] """Executes the scriptgen operation on the server. @@ -2165,11 +2371,11 @@ def SendRsAll(self, *args, **kwargs): def SetChassisMode(self, *args, **kwargs): """Executes the setChassisMode operation on the server. - Switch Mode(default/highRoute) for the default chassis. + Switch Mode(default/highRoute/ionvsFdb) for the default chassis. setChassisMode(Arg1=enum, Arg2=bool, async_operation=bool)object ---------------------------------------------------------------- - - Arg1 (str(default | highRoute)): Takes as input corresponding mode (default/highRoute). + - Arg1 (str(default | highRoute | ionvsFdb)): Takes as input corresponding mode (default/highRoute/ionvsFdb). - Arg2 (bool): take ownership if required. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns dict(arg1:str,arg2:str): Result if succesful or not,chassis hostname and the response message. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/cakcache_dfe6ea26428ccbc879e70415c02b2ccd.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/cakcache_dfe6ea26428ccbc879e70415c02b2ccd.py new file mode 100644 index 000000000..d7977d83a --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/cakcache_dfe6ea26428ccbc879e70415c02b2ccd.py @@ -0,0 +1,307 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class CakCache(Base): + """CAK Cache configuration. + The CakCache class encapsulates a required cakCache resource which will be retrieved from the server every time the property is accessed. + """ + + __slots__ = () + _SDM_NAME = "cakCache" + _SDM_ATT_MAP = { + "CakName": "cakName", + "CakValue128": "cakValue128", + "CakValue256": "cakValue256", + "Count": "count", + "DescriptiveName": "descriptiveName", + "KeyDuration": "keyDuration", + "KeyStartTime": "keyStartTime", + "LifetimeValidity": "lifetimeValidity", + "MemberIdentifier": "memberIdentifier", + "Name": "name", + "OverlappingKeys": "overlappingKeys", + "ParticipantState": "participantState", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(CakCache, self).__init__(parent, list_op) + + @property + def CakName(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Denotes CAK Name. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["CakName"])) + + @property + def CakValue128(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the 128 bit CAK value. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["CakValue128"])) + + @property + def CakValue256(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the 256 bit CAK value. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["CakValue256"])) + + @property + def Count(self): + # type: () -> int + """ + Returns + ------- + - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["Count"]) + + @property + def DescriptiveName(self): + # type: () -> str + """ + Returns + ------- + - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + """ + return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) + + @property + def KeyDuration(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Allows the user to configure the duration of this key. The timer values are relative to the Test Start Time configured in MKA port properties. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["KeyDuration"])) + + @property + def KeyStartTime(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Allows the user to configure the Start Time of this key. The timer values are relative to the Test Start Time configured in MKA port properties. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["KeyStartTime"])) + + @property + def LifetimeValidity(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines whether the CAK, CKN tuple expires or not. If enabled, the key will never expire. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["LifetimeValidity"]) + ) + + @property + def MemberIdentifier(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - list(obj(ixnetwork_restpy.multivalue.Multivalue)): Displays the Member Identifier calculated by the state machine for this MKA participant. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["MemberIdentifier"]) + ) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + @property + def OverlappingKeys(self): + # type: () -> bool + """ + Returns + ------- + - bool: If this box is un-checked, then the current key will expire on the activation of the next key. + """ + return self._get_attribute(self._SDM_ATT_MAP["OverlappingKeys"]) + + @OverlappingKeys.setter + def OverlappingKeys(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["OverlappingKeys"], value) + + @property + def ParticipantState(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str[active | activePrincipalActor | activeSuccessfulActor | expired | inactive | none]): Displays the state of this participant for this device (KaY). + """ + return self._get_attribute(self._SDM_ATT_MAP["ParticipantState"]) + + def update(self, Name=None, OverlappingKeys=None): + # type: (str, bool) -> CakCache + """Updates cakCache resource on the server. + + This method has some named parameters with a type: obj (Multivalue). + The Multivalue class has documentation that details the possible values for those named parameters. + + Args + ---- + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - OverlappingKeys (bool): If this box is un-checked, then the current key will expire on the activation of the next key. + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find( + self, + Count=None, + DescriptiveName=None, + Name=None, + OverlappingKeys=None, + ParticipantState=None, + ): + # type: (int, str, str, bool, List[str]) -> CakCache + """Finds and retrieves cakCache resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve cakCache resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all cakCache resources from the server. + + Args + ---- + - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - OverlappingKeys (bool): If this box is un-checked, then the current key will expire on the activation of the next key. + - ParticipantState (list(str[active | activePrincipalActor | activeSuccessfulActor | expired | inactive | none])): Displays the state of this participant for this device (KaY). + + Returns + ------- + - self: This instance with matching cakCache resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of cakCache data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the cakCache resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) + + def get_device_ids( + self, + PortNames=None, + CakName=None, + CakValue128=None, + CakValue256=None, + KeyDuration=None, + KeyStartTime=None, + LifetimeValidity=None, + MemberIdentifier=None, + ): + """Base class infrastructure that gets a list of cakCache device ids encapsulated by this object. + + Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. + + Args + ---- + - PortNames (str): optional regex of port names + - CakName (str): optional regex of cakName + - CakValue128 (str): optional regex of cakValue128 + - CakValue256 (str): optional regex of cakValue256 + - KeyDuration (str): optional regex of keyDuration + - KeyStartTime (str): optional regex of keyStartTime + - LifetimeValidity (str): optional regex of lifetimeValidity + - MemberIdentifier (str): optional regex of memberIdentifier + + Returns + ------- + - list(int): A list of device ids that meets the regex criteria provided in the method parameters + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._get_ngpf_device_ids(locals()) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/celltable_bf0a929f20d1c9f1dd3a8704ab2b1a4d.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/celltable_bf0a929f20d1c9f1dd3a8704ab2b1a4d.py new file mode 100644 index 000000000..3daf98e47 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/celltable_bf0a929f20d1c9f1dd3a8704ab2b1a4d.py @@ -0,0 +1,161 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class CellTable(Base): + """The node where learned information is grouped into tables or columns and rows. + The CellTable class encapsulates a list of cellTable resources that are managed by the system. + A list of resources can be retrieved from the server using the CellTable.find() method. + """ + + __slots__ = () + _SDM_NAME = "cellTable" + _SDM_ATT_MAP = { + "Actions": "actions", + "Columns": "columns", + "Type": "type", + "Values": "values", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(CellTable, self).__init__(parent, list_op) + + @property + def Col(self): + """DEPRECATED + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.col_667991bd02f140c2b2287de796fe1846.Col): An instance of the Col class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.col_667991bd02f140c2b2287de796fe1846 import ( + Col, + ) + + if len(self._object_properties) > 0: + if self._properties.get("Col", None) is not None: + return self._properties.get("Col") + return Col(self) + + @property + def Actions(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): The list of actions allowed on the learned information table + """ + return self._get_attribute(self._SDM_ATT_MAP["Actions"]) + + @property + def Columns(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): The list of columns in the learned information table + """ + return self._get_attribute(self._SDM_ATT_MAP["Columns"]) + + @property + def Type(self): + # type: () -> str + """ + Returns + ------- + - str: Description of the learned information type + """ + return self._get_attribute(self._SDM_ATT_MAP["Type"]) + + @property + def Values(self): + """ + Returns + ------- + - list(list[str]): A list of rows of learned information values + """ + return self._get_attribute(self._SDM_ATT_MAP["Values"]) + + def add(self): + """Adds a new cellTable resource on the json, only valid with batch add utility + + Returns + ------- + - self: This instance with all currently retrieved cellTable resources using find and the newly added cellTable resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Actions=None, Columns=None, Type=None, Values=None): + """Finds and retrieves cellTable resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve cellTable resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all cellTable resources from the server. + + Args + ---- + - Actions (list(str)): The list of actions allowed on the learned information table + - Columns (list(str)): The list of columns in the learned information table + - Type (str): Description of the learned information type + - Values (list(list[str])): A list of rows of learned information values + + Returns + ------- + - self: This instance with matching cellTable resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of cellTable data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the cellTable resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/col_667991bd02f140c2b2287de796fe1846.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/col_667991bd02f140c2b2287de796fe1846.py new file mode 100644 index 000000000..a4bec6b3a --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/col_667991bd02f140c2b2287de796fe1846.py @@ -0,0 +1,147 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class Col(Base): + """DEPRECATED A column view of learned information. + The Col class encapsulates a list of col resources that are managed by the system. + A list of resources can be retrieved from the server using the Col.find() method. + """ + + __slots__ = () + _SDM_NAME = "col" + _SDM_ATT_MAP = { + "Value": "value", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(Col, self).__init__(parent, list_op) + + @property + def CellTable(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.celltable_bf0a929f20d1c9f1dd3a8704ab2b1a4d.CellTable): An instance of the CellTable class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.celltable_bf0a929f20d1c9f1dd3a8704ab2b1a4d import ( + CellTable, + ) + + if len(self._object_properties) > 0: + if self._properties.get("CellTable", None) is not None: + return self._properties.get("CellTable") + return CellTable(self) + + @property + def Row(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.row_45173689e454bc6eba4167d6c8a281c5.Row): An instance of the Row class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.row_45173689e454bc6eba4167d6c8a281c5 import ( + Row, + ) + + if len(self._object_properties) > 0: + if self._properties.get("Row", None) is not None: + return self._properties.get("Row") + return Row(self) + + @property + def Value(self): + # type: () -> str + """ + Returns + ------- + - str: A learned information value + """ + return self._get_attribute(self._SDM_ATT_MAP["Value"]) + + def add(self): + """Adds a new col resource on the json, only valid with batch add utility + + Returns + ------- + - self: This instance with all currently retrieved col resources using find and the newly added col resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Value=None): + # type: (str) -> Col + """Finds and retrieves col resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve col resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all col resources from the server. + + Args + ---- + - Value (str): A learned information value + + Returns + ------- + - self: This instance with matching col resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of col data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the col resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/ethernet_16074ace2e581d9f35640391bde73384.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/ethernet_16074ace2e581d9f35640391bde73384.py index c97262850..53a186bf9 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/ethernet_16074ace2e581d9f35640391bde73384.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/ethernet_16074ace2e581d9f35640391bde73384.py @@ -129,6 +129,46 @@ def Lagportstaticlag(self): return self._properties.get("Lagportstaticlag") return Lagportstaticlag(self) + @property + def Macsec(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.macsec_b8fff0e525c0f50d0e7ed41aac1716c1.Macsec): An instance of the Macsec class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.macsec_b8fff0e525c0f50d0e7ed41aac1716c1 import ( + Macsec, + ) + + if len(self._object_properties) > 0: + if self._properties.get("Macsec", None) is not None: + return self._properties.get("Macsec") + return Macsec(self) + + @property + def Mka(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.mka_469fe6a9928108e87cb97539528a12d0.Mka): An instance of the Mka class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.mka_469fe6a9928108e87cb97539528a12d0 import ( + Mka, + ) + + if len(self._object_properties) > 0: + if self._properties.get("Mka", None) is not None: + return self._properties.get("Mka") + return Mka(self) + @property def PbbEVpnParameter(self): """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/innervlanlist_2ce357045269e46c7dbf130a33f29df4.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/innervlanlist_2ce357045269e46c7dbf130a33f29df4.py new file mode 100644 index 000000000..ae18da5f3 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/innervlanlist_2ce357045269e46c7dbf130a33f29df4.py @@ -0,0 +1,219 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class InnerVlanList(Base): + """Inner VLAN + The InnerVlanList class encapsulates a list of innerVlanList resources that are managed by the system. + A list of resources can be retrieved from the server using the InnerVlanList.find() method. + """ + + __slots__ = () + _SDM_NAME = "innerVlanList" + _SDM_ATT_MAP = { + "Count": "count", + "DescriptiveName": "descriptiveName", + "Name": "name", + "Priority": "priority", + "Tpid": "tpid", + "VlanId": "vlanId", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(InnerVlanList, self).__init__(parent, list_op) + + @property + def Count(self): + # type: () -> int + """ + Returns + ------- + - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["Count"]) + + @property + def DescriptiveName(self): + # type: () -> str + """ + Returns + ------- + - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + """ + return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + @property + def Priority(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): 3-bit user priority field in the VLAN tag. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Priority"])) + + @property + def Tpid(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): 16-bit Tag Protocol Identifier (TPID) or EtherType in the VLAN tag. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Tpid"])) + + @property + def VlanId(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): 12-bit VLAN ID in the VLAN tag. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["VlanId"])) + + def update(self, Name=None): + # type: (str) -> InnerVlanList + """Updates innerVlanList resource on the server. + + This method has some named parameters with a type: obj (Multivalue). + The Multivalue class has documentation that details the possible values for those named parameters. + + Args + ---- + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Name=None): + # type: (str) -> InnerVlanList + """Adds a new innerVlanList resource on the json, only valid with batch add utility + + Args + ---- + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Returns + ------- + - self: This instance with all currently retrieved innerVlanList resources using find and the newly added innerVlanList resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Count=None, DescriptiveName=None, Name=None): + # type: (int, str, str) -> InnerVlanList + """Finds and retrieves innerVlanList resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve innerVlanList resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all innerVlanList resources from the server. + + Args + ---- + - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Returns + ------- + - self: This instance with matching innerVlanList resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of innerVlanList data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the innerVlanList resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) + + def get_device_ids(self, PortNames=None, Priority=None, Tpid=None, VlanId=None): + """Base class infrastructure that gets a list of innerVlanList device ids encapsulated by this object. + + Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. + + Args + ---- + - PortNames (str): optional regex of port names + - Priority (str): optional regex of priority + - Tpid (str): optional regex of tpid + - VlanId (str): optional regex of vlanId + + Returns + ------- + - list(int): A list of device ids that meets the regex criteria provided in the method parameters + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._get_ngpf_device_ids(locals()) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/lag_cd537f07f912db233dacbe727e8568d7.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/lag_cd537f07f912db233dacbe727e8568d7.py index e9e62869d..2552516db 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/lag_cd537f07f912db233dacbe727e8568d7.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/lag_cd537f07f912db233dacbe727e8568d7.py @@ -55,13 +55,13 @@ def LagMode(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.lagmode_d3c47f2148e3a3acd418ebf95f2b7b4e.LagMode): An instance of the LagMode class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.lagmode_53b365e7fdae49570043f8b9d07a18da.LagMode): An instance of the LagMode class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.lagmode_d3c47f2148e3a3acd418ebf95f2b7b4e import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.lagmode_53b365e7fdae49570043f8b9d07a18da import ( LagMode, ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/lagmode_d3c47f2148e3a3acd418ebf95f2b7b4e.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/lagmode_53b365e7fdae49570043f8b9d07a18da.py similarity index 89% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/lagmode_d3c47f2148e3a3acd418ebf95f2b7b4e.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/lagmode_53b365e7fdae49570043f8b9d07a18da.py index 5e6625368..573e26ebd 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/lagmode_d3c47f2148e3a3acd418ebf95f2b7b4e.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/lagmode_53b365e7fdae49570043f8b9d07a18da.py @@ -36,6 +36,7 @@ class LagMode(Base): _SDM_NAME = "lagMode" _SDM_ATT_MAP = { "Count": "count", + "LagL23Protocol": "lagL23Protocol", "LagProtocol": "lagProtocol", } _SDM_ENUM_MAP = {} @@ -53,6 +54,20 @@ def Count(self): """ return self._get_attribute(self._SDM_ATT_MAP["Count"]) + @property + def LagL23Protocol(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): L23 Protocol + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["LagL23Protocol"]) + ) + @property def LagProtocol(self): # type: () -> 'Multivalue' @@ -105,7 +120,7 @@ def read(self, href): """ return self._read(href) - def get_device_ids(self, PortNames=None, LagProtocol=None): + def get_device_ids(self, PortNames=None, LagL23Protocol=None, LagProtocol=None): """Base class infrastructure that gets a list of lagMode device ids encapsulated by this object. Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. @@ -113,6 +128,7 @@ def get_device_ids(self, PortNames=None, LagProtocol=None): Args ---- - PortNames (str): optional regex of port names + - LagL23Protocol (str): optional regex of lagL23Protocol - LagProtocol (str): optional regex of lagProtocol Returns diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/learnedinfo_e3842fc998f50863a80ad08bc75a2de8.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/learnedinfo_e3842fc998f50863a80ad08bc75a2de8.py new file mode 100644 index 000000000..dc8b6307d --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/learnedinfo_e3842fc998f50863a80ad08bc75a2de8.py @@ -0,0 +1,193 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class LearnedInfo(Base): + """The main learned information node that contains tables of learned information. + The LearnedInfo class encapsulates a list of learnedInfo resources that are managed by the system. + A list of resources can be retrieved from the server using the LearnedInfo.find() method. + """ + + __slots__ = () + _SDM_NAME = "learnedInfo" + _SDM_ATT_MAP = { + "Id__": "__id__", + "Columns": "columns", + "State": "state", + "Type": "type", + "Values": "values", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(LearnedInfo, self).__init__(parent, list_op) + + @property + def Col(self): + """DEPRECATED + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.col_667991bd02f140c2b2287de796fe1846.Col): An instance of the Col class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.col_667991bd02f140c2b2287de796fe1846 import ( + Col, + ) + + if len(self._object_properties) > 0: + if self._properties.get("Col", None) is not None: + return self._properties.get("Col") + return Col(self) + + @property + def Table(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.table_5db82318b9a3adae08e0db1b40a3ca80.Table): An instance of the Table class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.table_5db82318b9a3adae08e0db1b40a3ca80 import ( + Table, + ) + + if len(self._object_properties) > 0: + if self._properties.get("Table", None) is not None: + return self._properties.get("Table") + return Table(self) + + @property + def Id__(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): A unique id for the learned information table + """ + return self._get_attribute(self._SDM_ATT_MAP["Id__"]) + + @property + def Columns(self): + # type: () -> List[str] + """DEPRECATED + Returns + ------- + - list(str): The list of columns in the learned information table + """ + return self._get_attribute(self._SDM_ATT_MAP["Columns"]) + + @property + def State(self): + # type: () -> str + """ + Returns + ------- + - str: The state of the learned information query + """ + return self._get_attribute(self._SDM_ATT_MAP["State"]) + + @property + def Type(self): + # type: () -> str + """DEPRECATED + Returns + ------- + - str: The type of learned information + """ + return self._get_attribute(self._SDM_ATT_MAP["Type"]) + + @property + def Values(self): + """DEPRECATED + Returns + ------- + - list(list[str]): A list of rows of learned information values + """ + return self._get_attribute(self._SDM_ATT_MAP["Values"]) + + def add(self): + """Adds a new learnedInfo resource on the json, only valid with batch add utility + + Returns + ------- + - self: This instance with all currently retrieved learnedInfo resources using find and the newly added learnedInfo resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Id__=None, Columns=None, State=None, Type=None, Values=None): + """Finds and retrieves learnedInfo resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve learnedInfo resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all learnedInfo resources from the server. + + Args + ---- + - Id__ (list(str)): A unique id for the learned information table + - Columns (list(str)): The list of columns in the learned information table + - State (str): The state of the learned information query + - Type (str): The type of learned information + - Values (list(list[str])): A list of rows of learned information values + + Returns + ------- + - self: This instance with matching learnedInfo resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of learnedInfo data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the learnedInfo resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/macsec_b8fff0e525c0f50d0e7ed41aac1716c1.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/macsec_b8fff0e525c0f50d0e7ed41aac1716c1.py new file mode 100644 index 000000000..2a2ac7dd6 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/macsec_b8fff0e525c0f50d0e7ed41aac1716c1.py @@ -0,0 +1,1221 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class Macsec(Base): + """Macsec + The Macsec class encapsulates a list of macsec resources that are managed by the user. + A list of resources can be retrieved from the server using the Macsec.find() method. + The list can be managed by using the Macsec.add() and Macsec.remove() methods. + """ + + __slots__ = () + _SDM_NAME = "macsec" + _SDM_ATT_MAP = { + "ActiveDevice": "activeDevice", + "CipherSuite": "cipherSuite", + "ConfidentialityOffset": "confidentialityOffset", + "ConnectedVia": "connectedVia", + "Count": "count", + "DescriptiveName": "descriptiveName", + "DutMsbOfXpn": "dutMsbOfXpn", + "DutSciMac": "dutSciMac", + "DutSciPortId": "dutSciPortId", + "EnableClearTextVlans": "enableClearTextVlans", + "EnableConfidentiality": "enableConfidentiality", + "EnableEncryptedVlans": "enableEncryptedVlans", + "EncryptedVlanCount": "encryptedVlanCount", + "EndStation": "endStation", + "Errors": "errors", + "ExcludedProtocols": "excludedProtocols", + "IncludeSci": "includeSci", + "InterleaveDuration": "interleaveDuration", + "InterleaveOldSak": "interleaveOldSak", + "Multiplier": "multiplier", + "Name": "name", + "OverrideTciSetting": "overrideTciSetting", + "PeriodicRekeyAttempts": "periodicRekeyAttempts", + "PeriodicRekeyInterval": "periodicRekeyInterval", + "PnExhaustionBehaviour": "pnExhaustionBehaviour", + "PortId": "portId", + "RekeyBehaviour": "rekeyBehaviour", + "RekeyMode": "rekeyMode", + "ReplayWindowSize": "replayWindowSize", + "RxSakPoolSize": "rxSakPoolSize", + "SessionStatus": "sessionStatus", + "SourceMac": "sourceMac", + "StackedLayers": "stackedLayers", + "StartingPn": "startingPn", + "StartingXpn": "startingXpn", + "StateCounts": "stateCounts", + "Status": "status", + "SystemId": "systemId", + "TciCBit": "tciCBit", + "TciEBit": "tciEBit", + "TciEsBit": "tciEsBit", + "TciScBit": "tciScBit", + "TciScbBit": "tciScbBit", + "TxSakPoolSize": "txSakPoolSize", + "Version": "version", + } + _SDM_ENUM_MAP = { + "rekeyBehaviour": ["dontRekey", "rekeyContinuous", "rekeyFixedCount"], + "rekeyMode": ["timerBased", "pnBased"], + "status": [ + "configured", + "error", + "mixed", + "notStarted", + "started", + "starting", + "stopping", + ], + } + + def __init__(self, parent, list_op=False): + super(Macsec, self).__init__(parent, list_op) + + @property + def InnerVlanList(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.innervlanlist_2ce357045269e46c7dbf130a33f29df4.InnerVlanList): An instance of the InnerVlanList class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.innervlanlist_2ce357045269e46c7dbf130a33f29df4 import ( + InnerVlanList, + ) + + if len(self._object_properties) > 0: + if self._properties.get("InnerVlanList", None) is not None: + return self._properties.get("InnerVlanList") + return InnerVlanList(self) + + @property + def Lagportlacp(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.lagportlacp_20ffef1c99dfba818871a069644627d6.Lagportlacp): An instance of the Lagportlacp class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.lagportlacp_20ffef1c99dfba818871a069644627d6 import ( + Lagportlacp, + ) + + if len(self._object_properties) > 0: + if self._properties.get("Lagportlacp", None) is not None: + return self._properties.get("Lagportlacp") + return Lagportlacp(self) + + @property + def Lagportstaticlag(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.lagportstaticlag_91864be5b58104e6349e12f415e28075.Lagportstaticlag): An instance of the Lagportstaticlag class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.lagportstaticlag_91864be5b58104e6349e12f415e28075 import ( + Lagportstaticlag, + ) + + if len(self._object_properties) > 0: + if self._properties.get("Lagportstaticlag", None) is not None: + return self._properties.get("Lagportstaticlag") + return Lagportstaticlag(self) + + @property + def Mka(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.mka_469fe6a9928108e87cb97539528a12d0.Mka): An instance of the Mka class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.mka_469fe6a9928108e87cb97539528a12d0 import ( + Mka, + ) + + if len(self._object_properties) > 0: + if self._properties.get("Mka", None) is not None: + return self._properties.get("Mka") + return Mka(self) + + @property + def RxSakPool(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.rxsakpool_cd41f87b984aa0c0b97c3462e829fc7c.RxSakPool): An instance of the RxSakPool class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.rxsakpool_cd41f87b984aa0c0b97c3462e829fc7c import ( + RxSakPool, + ) + + if len(self._object_properties) > 0: + if self._properties.get("RxSakPool", None) is not None: + return self._properties.get("RxSakPool") + return RxSakPool(self)._select() + + @property + def Tag(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.tag_5f7006f77d76d5947e1ccb4d9663920e.Tag): An instance of the Tag class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.tag_5f7006f77d76d5947e1ccb4d9663920e import ( + Tag, + ) + + if len(self._object_properties) > 0: + if self._properties.get("Tag", None) is not None: + return self._properties.get("Tag") + return Tag(self) + + @property + def TxSakPool(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.txsakpool_d388a9eb0094019eed187e78ca376c92.TxSakPool): An instance of the TxSakPool class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.txsakpool_d388a9eb0094019eed187e78ca376c92 import ( + TxSakPool, + ) + + if len(self._object_properties) > 0: + if self._properties.get("TxSakPool", None) is not None: + return self._properties.get("TxSakPool") + return TxSakPool(self)._select() + + @property + def ActiveDevice(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines whether a MACsec device is active or not. If disabled, MACsec will not be started on the device. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["ActiveDevice"])) + + @property + def CipherSuite(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): The type of cipher suite. Options include: 1) GCM-AES-128 2) GCM-AES-256 3) GCM-AES-XPN-128 4) GCM-AES-XPN-256 + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["CipherSuite"])) + + @property + def ConfidentialityOffset(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the confidentiality offset for both transmit and receive channel. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["ConfidentialityOffset"]) + ) + + @property + def ConnectedVia(self): + # type: () -> List[str] + """DEPRECATED + Returns + ------- + - list(str[None | /api/v1/sessions/1/ixnetwork/lag]): List of layers this layer is used to connect with to the wire. + """ + return self._get_attribute(self._SDM_ATT_MAP["ConnectedVia"]) + + @ConnectedVia.setter + def ConnectedVia(self, value): + # type: (List[str]) -> None + self._set_attribute(self._SDM_ATT_MAP["ConnectedVia"], value) + + @property + def Count(self): + # type: () -> int + """ + Returns + ------- + - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["Count"]) + + @property + def DescriptiveName(self): + # type: () -> str + """ + Returns + ------- + - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + """ + return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) + + @property + def DutMsbOfXpn(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): The 32 most significant bits of the XPN that DUT will be using to construct the 64 bits XPN value when test starts. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["DutMsbOfXpn"])) + + @property + def DutSciMac(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): MAC component of SCI with which MACsec traffic is expected from the DUT. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["DutSciMac"])) + + @property + def DutSciPortId(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Port ID component of SCI with which MACsec traffic is expected from the DUT. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["DutSciPortId"])) + + @property + def EnableClearTextVlans(self): + # type: () -> bool + """ + Returns + ------- + - bool: Determines whether the VLANs configured on the parent Ethernet layer are sent as clear text VLANs (before secTAG) or as encrypted VLANs (after secTAG). By default this is disabled and the VLANs configured on the parent Ethernet layer are copied to MACsec layer and sent as encrypted VLANs. + """ + return self._get_attribute(self._SDM_ATT_MAP["EnableClearTextVlans"]) + + @EnableClearTextVlans.setter + def EnableClearTextVlans(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["EnableClearTextVlans"], value) + + @property + def EnableConfidentiality(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines whether transmitted MACsec payload is encrypted or not. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["EnableConfidentiality"]) + ) + + @property + def EnableEncryptedVlans(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines whether configured encrypted VLANs are included in MACsec packets or not. It can be configured per device. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["EnableEncryptedVlans"]) + ) + + @property + def EncryptedVlanCount(self): + # type: () -> int + """ + Returns + ------- + - number: Denotes the number of VLANs to be sent as encrypted VLANs. Maximum 6 VLANs can be configured as encrypted VLANs. + """ + return self._get_attribute(self._SDM_ATT_MAP["EncryptedVlanCount"]) + + @EncryptedVlanCount.setter + def EncryptedVlanCount(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["EncryptedVlanCount"], value) + + @property + def EndStation(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines whether this device should act as the End Station. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["EndStation"])) + + @property + def Errors(self): + """ + Returns + ------- + - list(dict(arg1:str[None | /api/v1/sessions/1/ixnetwork/],arg2:list[str])): A list of errors that have occurred + """ + return self._get_attribute(self._SDM_ATT_MAP["Errors"]) + + @property + def ExcludedProtocols(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Excluded Protocol + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["ExcludedProtocols"]) + ) + + @property + def IncludeSci(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines whether SCI should be included in the SecTAG of the transmitted MACsec traffic. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["IncludeSci"])) + + @property + def InterleaveDuration(self): + # type: () -> int + """ + Returns + ------- + - number: Determines how long the Old and New SAKs should be interleaved. + """ + return self._get_attribute(self._SDM_ATT_MAP["InterleaveDuration"]) + + @InterleaveDuration.setter + def InterleaveDuration(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["InterleaveDuration"], value) + + @property + def InterleaveOldSak(self): + # type: () -> bool + """ + Returns + ------- + - bool: Determines whether Ixia interleaves Old and New SAKs after Rekey is triggered. + """ + return self._get_attribute(self._SDM_ATT_MAP["InterleaveOldSak"]) + + @InterleaveOldSak.setter + def InterleaveOldSak(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["InterleaveOldSak"], value) + + @property + def Multiplier(self): + # type: () -> int + """ + Returns + ------- + - number: Number of layer instances per parent instance (multiplier) + """ + return self._get_attribute(self._SDM_ATT_MAP["Multiplier"]) + + @Multiplier.setter + def Multiplier(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["Multiplier"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + @property + def OverrideTciSetting(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): If enabled, the default TCI settings as per configuration will be allowed for overwriting. Used to simulate mal-configured SecTAG for negative testing. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["OverrideTciSetting"]) + ) + + @property + def PeriodicRekeyAttempts(self): + # type: () -> int + """ + Returns + ------- + - number: Determines the number of times Rekey will happen after MACsec is started. + """ + return self._get_attribute(self._SDM_ATT_MAP["PeriodicRekeyAttempts"]) + + @PeriodicRekeyAttempts.setter + def PeriodicRekeyAttempts(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["PeriodicRekeyAttempts"], value) + + @property + def PeriodicRekeyInterval(self): + # type: () -> int + """ + Returns + ------- + - number: Determines the time interval between two subsequent Rekey events. The timer starts with the first MACsec packet transmission from a device. + """ + return self._get_attribute(self._SDM_ATT_MAP["PeriodicRekeyInterval"]) + + @PeriodicRekeyInterval.setter + def PeriodicRekeyInterval(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["PeriodicRekeyInterval"], value) + + @property + def PnExhaustionBehaviour(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): What should Ixia tx port do if PN has exhausted but no new SAK is available from MKA or Rekey Timer has not expired. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["PnExhaustionBehaviour"]) + ) + + @property + def PortId(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Port ID component of SCI with which MACsec traffic is transmitted. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["PortId"])) + + @property + def RekeyBehaviour(self): + # type: () -> str + """ + Returns + ------- + - str(dontRekey | rekeyContinuous | rekeyFixedCount): Determines the Rekey behavior. + """ + return self._get_attribute(self._SDM_ATT_MAP["RekeyBehaviour"]) + + @RekeyBehaviour.setter + def RekeyBehaviour(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["RekeyBehaviour"], value) + + @property + def RekeyMode(self): + # type: () -> str + """ + Returns + ------- + - str(timerBased | pnBased): Rekey criteria, either PN based or Timer based. + """ + return self._get_attribute(self._SDM_ATT_MAP["RekeyMode"]) + + @RekeyMode.setter + def RekeyMode(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["RekeyMode"], value) + + @property + def ReplayWindowSize(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Window size required for calculating LAPN. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["ReplayWindowSize"]) + ) + + @property + def RxSakPoolSize(self): + # type: () -> int + """ + Returns + ------- + - number: Determines the number of SAKs configured for each device for the Rx secure channel. Multiple SAKs are needed if DUT is expected to trigger Rekey during the test. + """ + return self._get_attribute(self._SDM_ATT_MAP["RxSakPoolSize"]) + + @RxSakPoolSize.setter + def RxSakPoolSize(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["RxSakPoolSize"], value) + + @property + def SessionStatus(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str[down | notStarted | up]): Current state of protocol session: Not Started - session negotiation not started, the session is not active yet. Down - actively trying to bring up a protocol session, but negotiation is didn't successfully complete (yet). Up - session came up successfully. + """ + return self._get_attribute(self._SDM_ATT_MAP["SessionStatus"]) + + @property + def SourceMac(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): MAC address of the Ethernet devices configured in the Ethernet stack. + """ + return self._get_attribute(self._SDM_ATT_MAP["SourceMac"]) + + @SourceMac.setter + def SourceMac(self, value): + # type: (List[str]) -> None + self._set_attribute(self._SDM_ATT_MAP["SourceMac"], value) + + @property + def StackedLayers(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str[None | /api/v1/sessions/1/ixnetwork/lag]): List of secondary (many to one) child layer protocols + """ + return self._get_attribute(self._SDM_ATT_MAP["StackedLayers"]) + + @StackedLayers.setter + def StackedLayers(self, value): + # type: (List[str]) -> None + self._set_attribute(self._SDM_ATT_MAP["StackedLayers"], value) + + @property + def StartingPn(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): PN value with which MACsec packet transmission starts both for the first time as well as after Rekey. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["StartingPn"])) + + @property + def StartingXpn(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): XPN value with which MACsec packet transmission starts. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["StartingXpn"])) + + @property + def StateCounts(self): + """ + Returns + ------- + - dict(total:number,notStarted:number,down:number,up:number): A list of values that indicates the total number of sessions, the number of sessions not started, the number of sessions down and the number of sessions that are up + """ + return self._get_attribute(self._SDM_ATT_MAP["StateCounts"]) + + @property + def Status(self): + # type: () -> str + """ + Returns + ------- + - str(configured | error | mixed | notStarted | started | starting | stopping): Running status of associated network element. Once in Started state, protocol sessions will begin to negotiate. + """ + return self._get_attribute(self._SDM_ATT_MAP["Status"]) + + @property + def SystemId(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): System Identifier component of the SCI field with which MACsec traffic is transmitted. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["SystemId"])) + + @property + def TciCBit(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the C bit in TCI field of SecTAG if Override TCI Settings is enabled. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["TciCBit"])) + + @property + def TciEBit(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the E bit in TCI field of SecTAG if Override TCI Settings is enabled. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["TciEBit"])) + + @property + def TciEsBit(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the ES bit in TCI field of SecTAG if Override TCI Settings is enabled. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["TciEsBit"])) + + @property + def TciScBit(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the SC bit in TCI field of SecTAG if Override TCI Settings is enabled. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["TciScBit"])) + + @property + def TciScbBit(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the SCB bit in TCI field of SecTAG if Override TCI Settings is enabled. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["TciScbBit"])) + + @property + def TxSakPoolSize(self): + # type: () -> int + """ + Returns + ------- + - number: Determines the number of SAKs configured for each device for the Tx secure channel. Multiple SAKs are needed if Rekey scenario is to be simulated. + """ + return self._get_attribute(self._SDM_ATT_MAP["TxSakPoolSize"]) + + @TxSakPoolSize.setter + def TxSakPoolSize(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["TxSakPoolSize"], value) + + @property + def Version(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Version bit in TCI field of SecTAG if Override TCI Settings is enabled. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Version"])) + + def update( + self, + ConnectedVia=None, + EnableClearTextVlans=None, + EncryptedVlanCount=None, + InterleaveDuration=None, + InterleaveOldSak=None, + Multiplier=None, + Name=None, + PeriodicRekeyAttempts=None, + PeriodicRekeyInterval=None, + RekeyBehaviour=None, + RekeyMode=None, + RxSakPoolSize=None, + SourceMac=None, + StackedLayers=None, + TxSakPoolSize=None, + ): + # type: (List[str], bool, int, int, bool, int, str, int, int, str, str, int, List[str], List[str], int) -> Macsec + """Updates macsec resource on the server. + + This method has some named parameters with a type: obj (Multivalue). + The Multivalue class has documentation that details the possible values for those named parameters. + + Args + ---- + - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/lag])): List of layers this layer is used to connect with to the wire. + - EnableClearTextVlans (bool): Determines whether the VLANs configured on the parent Ethernet layer are sent as clear text VLANs (before secTAG) or as encrypted VLANs (after secTAG). By default this is disabled and the VLANs configured on the parent Ethernet layer are copied to MACsec layer and sent as encrypted VLANs. + - EncryptedVlanCount (number): Denotes the number of VLANs to be sent as encrypted VLANs. Maximum 6 VLANs can be configured as encrypted VLANs. + - InterleaveDuration (number): Determines how long the Old and New SAKs should be interleaved. + - InterleaveOldSak (bool): Determines whether Ixia interleaves Old and New SAKs after Rekey is triggered. + - Multiplier (number): Number of layer instances per parent instance (multiplier) + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - PeriodicRekeyAttempts (number): Determines the number of times Rekey will happen after MACsec is started. + - PeriodicRekeyInterval (number): Determines the time interval between two subsequent Rekey events. The timer starts with the first MACsec packet transmission from a device. + - RekeyBehaviour (str(dontRekey | rekeyContinuous | rekeyFixedCount)): Determines the Rekey behavior. + - RekeyMode (str(timerBased | pnBased)): Rekey criteria, either PN based or Timer based. + - RxSakPoolSize (number): Determines the number of SAKs configured for each device for the Rx secure channel. Multiple SAKs are needed if DUT is expected to trigger Rekey during the test. + - SourceMac (list(str)): MAC address of the Ethernet devices configured in the Ethernet stack. + - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/lag])): List of secondary (many to one) child layer protocols + - TxSakPoolSize (number): Determines the number of SAKs configured for each device for the Tx secure channel. Multiple SAKs are needed if Rekey scenario is to be simulated. + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add( + self, + ConnectedVia=None, + EnableClearTextVlans=None, + EncryptedVlanCount=None, + InterleaveDuration=None, + InterleaveOldSak=None, + Multiplier=None, + Name=None, + PeriodicRekeyAttempts=None, + PeriodicRekeyInterval=None, + RekeyBehaviour=None, + RekeyMode=None, + RxSakPoolSize=None, + SourceMac=None, + StackedLayers=None, + TxSakPoolSize=None, + ): + # type: (List[str], bool, int, int, bool, int, str, int, int, str, str, int, List[str], List[str], int) -> Macsec + """Adds a new macsec resource on the server and adds it to the container. + + Args + ---- + - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/lag])): List of layers this layer is used to connect with to the wire. + - EnableClearTextVlans (bool): Determines whether the VLANs configured on the parent Ethernet layer are sent as clear text VLANs (before secTAG) or as encrypted VLANs (after secTAG). By default this is disabled and the VLANs configured on the parent Ethernet layer are copied to MACsec layer and sent as encrypted VLANs. + - EncryptedVlanCount (number): Denotes the number of VLANs to be sent as encrypted VLANs. Maximum 6 VLANs can be configured as encrypted VLANs. + - InterleaveDuration (number): Determines how long the Old and New SAKs should be interleaved. + - InterleaveOldSak (bool): Determines whether Ixia interleaves Old and New SAKs after Rekey is triggered. + - Multiplier (number): Number of layer instances per parent instance (multiplier) + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - PeriodicRekeyAttempts (number): Determines the number of times Rekey will happen after MACsec is started. + - PeriodicRekeyInterval (number): Determines the time interval between two subsequent Rekey events. The timer starts with the first MACsec packet transmission from a device. + - RekeyBehaviour (str(dontRekey | rekeyContinuous | rekeyFixedCount)): Determines the Rekey behavior. + - RekeyMode (str(timerBased | pnBased)): Rekey criteria, either PN based or Timer based. + - RxSakPoolSize (number): Determines the number of SAKs configured for each device for the Rx secure channel. Multiple SAKs are needed if DUT is expected to trigger Rekey during the test. + - SourceMac (list(str)): MAC address of the Ethernet devices configured in the Ethernet stack. + - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/lag])): List of secondary (many to one) child layer protocols + - TxSakPoolSize (number): Determines the number of SAKs configured for each device for the Tx secure channel. Multiple SAKs are needed if Rekey scenario is to be simulated. + + Returns + ------- + - self: This instance with all currently retrieved macsec resources using find and the newly added macsec resources available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._create(self._map_locals(self._SDM_ATT_MAP, locals())) + + def remove(self): + """Deletes all the contained macsec resources in this instance from the server. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + self._delete() + + def find( + self, + ConnectedVia=None, + Count=None, + DescriptiveName=None, + EnableClearTextVlans=None, + EncryptedVlanCount=None, + Errors=None, + InterleaveDuration=None, + InterleaveOldSak=None, + Multiplier=None, + Name=None, + PeriodicRekeyAttempts=None, + PeriodicRekeyInterval=None, + RekeyBehaviour=None, + RekeyMode=None, + RxSakPoolSize=None, + SessionStatus=None, + SourceMac=None, + StackedLayers=None, + StateCounts=None, + Status=None, + TxSakPoolSize=None, + ): + """Finds and retrieves macsec resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve macsec resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all macsec resources from the server. + + Args + ---- + - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/lag])): List of layers this layer is used to connect with to the wire. + - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + - EnableClearTextVlans (bool): Determines whether the VLANs configured on the parent Ethernet layer are sent as clear text VLANs (before secTAG) or as encrypted VLANs (after secTAG). By default this is disabled and the VLANs configured on the parent Ethernet layer are copied to MACsec layer and sent as encrypted VLANs. + - EncryptedVlanCount (number): Denotes the number of VLANs to be sent as encrypted VLANs. Maximum 6 VLANs can be configured as encrypted VLANs. + - Errors (list(dict(arg1:str[None | /api/v1/sessions/1/ixnetwork/],arg2:list[str]))): A list of errors that have occurred + - InterleaveDuration (number): Determines how long the Old and New SAKs should be interleaved. + - InterleaveOldSak (bool): Determines whether Ixia interleaves Old and New SAKs after Rekey is triggered. + - Multiplier (number): Number of layer instances per parent instance (multiplier) + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - PeriodicRekeyAttempts (number): Determines the number of times Rekey will happen after MACsec is started. + - PeriodicRekeyInterval (number): Determines the time interval between two subsequent Rekey events. The timer starts with the first MACsec packet transmission from a device. + - RekeyBehaviour (str(dontRekey | rekeyContinuous | rekeyFixedCount)): Determines the Rekey behavior. + - RekeyMode (str(timerBased | pnBased)): Rekey criteria, either PN based or Timer based. + - RxSakPoolSize (number): Determines the number of SAKs configured for each device for the Rx secure channel. Multiple SAKs are needed if DUT is expected to trigger Rekey during the test. + - SessionStatus (list(str[down | notStarted | up])): Current state of protocol session: Not Started - session negotiation not started, the session is not active yet. Down - actively trying to bring up a protocol session, but negotiation is didn't successfully complete (yet). Up - session came up successfully. + - SourceMac (list(str)): MAC address of the Ethernet devices configured in the Ethernet stack. + - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/lag])): List of secondary (many to one) child layer protocols + - StateCounts (dict(total:number,notStarted:number,down:number,up:number)): A list of values that indicates the total number of sessions, the number of sessions not started, the number of sessions down and the number of sessions that are up + - Status (str(configured | error | mixed | notStarted | started | starting | stopping)): Running status of associated network element. Once in Started state, protocol sessions will begin to negotiate. + - TxSakPoolSize (number): Determines the number of SAKs configured for each device for the Tx secure channel. Multiple SAKs are needed if Rekey scenario is to be simulated. + + Returns + ------- + - self: This instance with matching macsec resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of macsec data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the macsec resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) + + def Abort(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the abort operation on the server. + + Abort CPF control plane (equals to demote to kUnconfigured state). + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + abort(async_operation=bool) + --------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + abort(SessionIndices=list, async_operation=bool) + ------------------------------------------------ + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + abort(SessionIndices=string, async_operation=bool) + -------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("abort", payload=payload, response_object=None) + + def RestartDown(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the restartDown operation on the server. + + Stop and start interfaces and sessions that are in Down state. + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + restartDown(async_operation=bool) + --------------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + restartDown(SessionIndices=list, async_operation=bool) + ------------------------------------------------------ + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + restartDown(SessionIndices=string, async_operation=bool) + -------------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("restartDown", payload=payload, response_object=None) + + def Start(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the start operation on the server. + + Start CPF control plane (equals to promote to negotiated state). + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + start(async_operation=bool) + --------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + start(SessionIndices=list, async_operation=bool) + ------------------------------------------------ + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + start(SessionIndices=string, async_operation=bool) + -------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("start", payload=payload, response_object=None) + + def Stop(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the stop operation on the server. + + Stop CPF control plane (equals to demote to PreValidated-DoDDone state). + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + stop(async_operation=bool) + -------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + stop(SessionIndices=list, async_operation=bool) + ----------------------------------------------- + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + stop(SessionIndices=string, async_operation=bool) + ------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("stop", payload=payload, response_object=None) + + def get_device_ids( + self, + PortNames=None, + ActiveDevice=None, + CipherSuite=None, + ConfidentialityOffset=None, + DutMsbOfXpn=None, + DutSciMac=None, + DutSciPortId=None, + EnableConfidentiality=None, + EnableEncryptedVlans=None, + EndStation=None, + ExcludedProtocols=None, + IncludeSci=None, + OverrideTciSetting=None, + PnExhaustionBehaviour=None, + PortId=None, + ReplayWindowSize=None, + StartingPn=None, + StartingXpn=None, + SystemId=None, + TciCBit=None, + TciEBit=None, + TciEsBit=None, + TciScBit=None, + TciScbBit=None, + Version=None, + ): + """Base class infrastructure that gets a list of macsec device ids encapsulated by this object. + + Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. + + Args + ---- + - PortNames (str): optional regex of port names + - ActiveDevice (str): optional regex of activeDevice + - CipherSuite (str): optional regex of cipherSuite + - ConfidentialityOffset (str): optional regex of confidentialityOffset + - DutMsbOfXpn (str): optional regex of dutMsbOfXpn + - DutSciMac (str): optional regex of dutSciMac + - DutSciPortId (str): optional regex of dutSciPortId + - EnableConfidentiality (str): optional regex of enableConfidentiality + - EnableEncryptedVlans (str): optional regex of enableEncryptedVlans + - EndStation (str): optional regex of endStation + - ExcludedProtocols (str): optional regex of excludedProtocols + - IncludeSci (str): optional regex of includeSci + - OverrideTciSetting (str): optional regex of overrideTciSetting + - PnExhaustionBehaviour (str): optional regex of pnExhaustionBehaviour + - PortId (str): optional regex of portId + - ReplayWindowSize (str): optional regex of replayWindowSize + - StartingPn (str): optional regex of startingPn + - StartingXpn (str): optional regex of startingXpn + - SystemId (str): optional regex of systemId + - TciCBit (str): optional regex of tciCBit + - TciEBit (str): optional regex of tciEBit + - TciEsBit (str): optional regex of tciEsBit + - TciScBit (str): optional regex of tciScBit + - TciScbBit (str): optional regex of tciScbBit + - Version (str): optional regex of version + + Returns + ------- + - list(int): A list of device ids that meets the regex criteria provided in the method parameters + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._get_ngpf_device_ids(locals()) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/mka_469fe6a9928108e87cb97539528a12d0.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/mka_469fe6a9928108e87cb97539528a12d0.py new file mode 100644 index 000000000..c4eb485f7 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/mka_469fe6a9928108e87cb97539528a12d0.py @@ -0,0 +1,1499 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class Mka(Base): + """Mka + The Mka class encapsulates a list of mka resources that are managed by the user. + A list of resources can be retrieved from the server using the Mka.find() method. + The list can be managed by using the Mka.add() and Mka.remove() methods. + """ + + __slots__ = () + _SDM_NAME = "mka" + _SDM_ATT_MAP = { + "ActiveDevice": "activeDevice", + "AssociationNumber": "associationNumber", + "CakCount": "cakCount", + "CipherSuite": "cipherSuite", + "ConfidentialityOffset": "confidentialityOffset", + "ConnectedVia": "connectedVia", + "Count": "count", + "DelayProtect": "delayProtect", + "DelayProtectSimulation": "delayProtectSimulation", + "DescriptiveName": "descriptiveName", + "ElectedKeyServer": "electedKeyServer", + "Errors": "errors", + "KeyDerivationFunction": "keyDerivationFunction", + "KeyServerPriority": "keyServerPriority", + "KeyType": "keyType", + "LlpnStep": "llpnStep", + "MacsecCapability": "macsecCapability", + "MacsecDesired": "macsecDesired", + "MemberIdentifier": "memberIdentifier", + "MirroredMacAddr": "mirroredMacAddr", + "MkaHelloTime": "mkaHelloTime", + "MkaLifeTime": "mkaLifeTime", + "MkaVersion": "mkaVersion", + "Multiplier": "multiplier", + "Name": "name", + "OlpnStep": "olpnStep", + "PeriodicRekeyAttempts": "periodicRekeyAttempts", + "PeriodicRekeyInterval": "periodicRekeyInterval", + "RandomizeMemberIdentifier": "randomizeMemberIdentifier", + "RekeyBehaviour": "rekeyBehaviour", + "RekeyMode": "rekeyMode", + "RekeyThresholdPN": "rekeyThresholdPN", + "RekeyThresholdXPN": "rekeyThresholdXPN", + "Sak": "sak", + "SendICVIndicator": "sendICVIndicator", + "SessionStatus": "sessionStatus", + "StackedLayers": "stackedLayers", + "StartingDistributedAN": "startingDistributedAN", + "StartingKeyNumber": "startingKeyNumber", + "StartingLLPN": "startingLLPN", + "StartingOLPN": "startingOLPN", + "StateCounts": "stateCounts", + "Status": "status", + "SupportedCipherSuites": "supportedCipherSuites", + "TxChannelCount": "txChannelCount", + } + _SDM_ENUM_MAP = { + "keyType": ["psk"], + "rekeyBehaviour": ["dontRekey", "rekeyContinuous", "rekeyFixedCount"], + "rekeyMode": ["timerBased", "pNBased"], + "status": [ + "configured", + "error", + "mixed", + "notStarted", + "started", + "starting", + "stopping", + ], + } + + def __init__(self, parent, list_op=False): + super(Mka, self).__init__(parent, list_op) + + @property + def CakCache(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.cakcache_dfe6ea26428ccbc879e70415c02b2ccd.CakCache): An instance of the CakCache class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.cakcache_dfe6ea26428ccbc879e70415c02b2ccd import ( + CakCache, + ) + + if len(self._object_properties) > 0: + if self._properties.get("CakCache", None) is not None: + return self._properties.get("CakCache") + return CakCache(self)._select() + + @property + def LearnedInfo(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.learnedinfo_e3842fc998f50863a80ad08bc75a2de8.LearnedInfo): An instance of the LearnedInfo class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.learnedinfo_e3842fc998f50863a80ad08bc75a2de8 import ( + LearnedInfo, + ) + + if len(self._object_properties) > 0: + if self._properties.get("LearnedInfo", None) is not None: + return self._properties.get("LearnedInfo") + return LearnedInfo(self) + + @property + def TxChannels(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.txchannels_b00cc0f5ee44e7e1276269692ddc248a.TxChannels): An instance of the TxChannels class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.txchannels_b00cc0f5ee44e7e1276269692ddc248a import ( + TxChannels, + ) + + if len(self._object_properties) > 0: + if self._properties.get("TxChannels", None) is not None: + return self._properties.get("TxChannels") + return TxChannels(self)._select() + + @property + def ActiveDevice(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines whether an MKA device is active or not. If disabled, MKA will not be started on the device. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["ActiveDevice"])) + + @property + def AssociationNumber(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): Displays the Association Number for the received SAK. + """ + return self._get_attribute(self._SDM_ATT_MAP["AssociationNumber"]) + + @property + def CakCount(self): + # type: () -> int + """ + Returns + ------- + - number: PSK Chain Size (Min 1, Max 10). + """ + return self._get_attribute(self._SDM_ATT_MAP["CakCount"]) + + @CakCount.setter + def CakCount(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["CakCount"], value) + + @property + def CipherSuite(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the type of cipher suite. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["CipherSuite"])) + + @property + def ConfidentialityOffset(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the confidentiality offset. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["ConfidentialityOffset"]) + ) + + @property + def ConnectedVia(self): + # type: () -> List[str] + """DEPRECATED + Returns + ------- + - list(str[None | /api/v1/sessions/1/ixnetwork/lag]): List of layers this layer is used to connect with to the wire. + """ + return self._get_attribute(self._SDM_ATT_MAP["ConnectedVia"]) + + @ConnectedVia.setter + def ConnectedVia(self, value): + # type: (List[str]) -> None + self._set_attribute(self._SDM_ATT_MAP["ConnectedVia"], value) + + @property + def Count(self): + # type: () -> int + """ + Returns + ------- + - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["Count"]) + + @property + def DelayProtect(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Delay Protect behavior of the device. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["DelayProtect"])) + + @property + def DelayProtectSimulation(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): Displays the actual PN, simulated PN and the MKPDU message number. + """ + return self._get_attribute(self._SDM_ATT_MAP["DelayProtectSimulation"]) + + @property + def DescriptiveName(self): + # type: () -> str + """ + Returns + ------- + - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + """ + return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) + + @property + def ElectedKeyServer(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): Denotes whether this device has been elected as a Key Server or not. + """ + return self._get_attribute(self._SDM_ATT_MAP["ElectedKeyServer"]) + + @property + def Errors(self): + """ + Returns + ------- + - list(dict(arg1:str[None | /api/v1/sessions/1/ixnetwork/],arg2:list[str])): A list of errors that have occurred + """ + return self._get_attribute(self._SDM_ATT_MAP["Errors"]) + + @property + def KeyDerivationFunction(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the KDF used to generate keys used by MKA. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["KeyDerivationFunction"]) + ) + + @property + def KeyServerPriority(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the Key Server Priority. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["KeyServerPriority"]) + ) + + @property + def KeyType(self): + # type: () -> str + """ + Returns + ------- + - str(psk): Indicates the source of CAK. + """ + return self._get_attribute(self._SDM_ATT_MAP["KeyType"]) + + @KeyType.setter + def KeyType(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["KeyType"], value) + + @property + def LlpnStep(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the LLPN Step. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["LlpnStep"])) + + @property + def MacsecCapability(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Indicates MACsec capabilities. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["MacsecCapability"]) + ) + + @property + def MacsecDesired(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines whether MACsec is desired or not. It is advertised in periodic hellos. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["MacsecDesired"])) + + @property + def MemberIdentifier(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - list(obj(ixnetwork_restpy.multivalue.Multivalue)): Displays the Member Identifier calculated by the state machine. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["MemberIdentifier"]) + ) + + @property + def MirroredMacAddr(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): MAC address of the Ethernet devices configured in the Ethernet stack. + """ + return self._get_attribute(self._SDM_ATT_MAP["MirroredMacAddr"]) + + @property + def MkaHelloTime(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Indicates MKA Hello Time. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["MkaHelloTime"])) + + @property + def MkaLifeTime(self): + # type: () -> int + """ + Returns + ------- + - number: Indicates MKA Life Time of a Peer. + """ + return self._get_attribute(self._SDM_ATT_MAP["MkaLifeTime"]) + + @MkaLifeTime.setter + def MkaLifeTime(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["MkaLifeTime"], value) + + @property + def MkaVersion(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Indicates the version of MKA. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["MkaVersion"])) + + @property + def Multiplier(self): + # type: () -> int + """ + Returns + ------- + - number: Number of layer instances per parent instance (multiplier) + """ + return self._get_attribute(self._SDM_ATT_MAP["Multiplier"]) + + @Multiplier.setter + def Multiplier(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["Multiplier"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + @property + def OlpnStep(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the OLPN Step. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["OlpnStep"])) + + @property + def PeriodicRekeyAttempts(self): + # type: () -> int + """ + Returns + ------- + - number: Number of times Rekey should be triggered. + """ + return self._get_attribute(self._SDM_ATT_MAP["PeriodicRekeyAttempts"]) + + @PeriodicRekeyAttempts.setter + def PeriodicRekeyAttempts(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["PeriodicRekeyAttempts"], value) + + @property + def PeriodicRekeyInterval(self): + # type: () -> int + """ + Returns + ------- + - number: Time interval between two Rekey triggers. + """ + return self._get_attribute(self._SDM_ATT_MAP["PeriodicRekeyInterval"]) + + @PeriodicRekeyInterval.setter + def PeriodicRekeyInterval(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["PeriodicRekeyInterval"], value) + + @property + def RandomizeMemberIdentifier(self): + # type: () -> bool + """ + Returns + ------- + - bool: If this box is checked, then Ixia MKA devices will generate random member identifiers. Otherwise member identifiers of the form MAC Address-Counter will be generated to aid in debugging. + """ + return self._get_attribute(self._SDM_ATT_MAP["RandomizeMemberIdentifier"]) + + @RandomizeMemberIdentifier.setter + def RandomizeMemberIdentifier(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["RandomizeMemberIdentifier"], value) + + @property + def RekeyBehaviour(self): + # type: () -> str + """ + Returns + ------- + - str(dontRekey | rekeyContinuous | rekeyFixedCount): Determines the Rekey behavior. + """ + return self._get_attribute(self._SDM_ATT_MAP["RekeyBehaviour"]) + + @RekeyBehaviour.setter + def RekeyBehaviour(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["RekeyBehaviour"], value) + + @property + def RekeyMode(self): + # type: () -> str + """ + Returns + ------- + - str(timerBased | pNBased): Rekey criteria. + """ + return self._get_attribute(self._SDM_ATT_MAP["RekeyMode"]) + + @RekeyMode.setter + def RekeyMode(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["RekeyMode"], value) + + @property + def RekeyThresholdPN(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the PN rekey threshold. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["RekeyThresholdPN"]) + ) + + @property + def RekeyThresholdXPN(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the XPN rekey threshold. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["RekeyThresholdXPN"]) + ) + + @property + def Sak(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): Displays the SAK received from the Key Server. + """ + return self._get_attribute(self._SDM_ATT_MAP["Sak"]) + + @property + def SendICVIndicator(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Send ICV Indicator in MKPDU. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["SendICVIndicator"]) + ) + + @property + def SessionStatus(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str[down | notStarted | up]): Current state of protocol session: Not Started - session negotiation not started, the session is not active yet. Down - actively trying to bring up a protocol session, but negotiation is didn't successfully complete (yet). Up - session came up successfully. + """ + return self._get_attribute(self._SDM_ATT_MAP["SessionStatus"]) + + @property + def StackedLayers(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str[None | /api/v1/sessions/1/ixnetwork/lag]): List of secondary (many to one) child layer protocols + """ + return self._get_attribute(self._SDM_ATT_MAP["StackedLayers"]) + + @StackedLayers.setter + def StackedLayers(self, value): + # type: (List[str]) -> None + self._set_attribute(self._SDM_ATT_MAP["StackedLayers"], value) + + @property + def StartingDistributedAN(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines starting distributed AN. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["StartingDistributedAN"]) + ) + + @property + def StartingKeyNumber(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the starting key number. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["StartingKeyNumber"]) + ) + + @property + def StartingLLPN(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Indicates the starting LLPN. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["StartingLLPN"])) + + @property + def StartingOLPN(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Indicates the starting OLPN. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["StartingOLPN"])) + + @property + def StateCounts(self): + """ + Returns + ------- + - dict(total:number,notStarted:number,down:number,up:number): A list of values that indicates the total number of sessions, the number of sessions not started, the number of sessions down and the number of sessions that are up + """ + return self._get_attribute(self._SDM_ATT_MAP["StateCounts"]) + + @property + def Status(self): + # type: () -> str + """ + Returns + ------- + - str(configured | error | mixed | notStarted | started | starting | stopping): Running status of associated network element. Once in Started state, protocol sessions will begin to negotiate. + """ + return self._get_attribute(self._SDM_ATT_MAP["Status"]) + + @property + def SupportedCipherSuites(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): The list of cipher suites supported by the device. All options are selected by default. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["SupportedCipherSuites"]) + ) + + @property + def TxChannelCount(self): + # type: () -> int + """ + Returns + ------- + - number: Determines the number of Tx Channels configured for each device. + """ + return self._get_attribute(self._SDM_ATT_MAP["TxChannelCount"]) + + def update( + self, + CakCount=None, + ConnectedVia=None, + KeyType=None, + MkaLifeTime=None, + Multiplier=None, + Name=None, + PeriodicRekeyAttempts=None, + PeriodicRekeyInterval=None, + RandomizeMemberIdentifier=None, + RekeyBehaviour=None, + RekeyMode=None, + StackedLayers=None, + ): + # type: (int, List[str], str, int, int, str, int, int, bool, str, str, List[str]) -> Mka + """Updates mka resource on the server. + + This method has some named parameters with a type: obj (Multivalue). + The Multivalue class has documentation that details the possible values for those named parameters. + + Args + ---- + - CakCount (number): PSK Chain Size (Min 1, Max 10). + - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/lag])): List of layers this layer is used to connect with to the wire. + - KeyType (str(psk)): Indicates the source of CAK. + - MkaLifeTime (number): Indicates MKA Life Time of a Peer. + - Multiplier (number): Number of layer instances per parent instance (multiplier) + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - PeriodicRekeyAttempts (number): Number of times Rekey should be triggered. + - PeriodicRekeyInterval (number): Time interval between two Rekey triggers. + - RandomizeMemberIdentifier (bool): If this box is checked, then Ixia MKA devices will generate random member identifiers. Otherwise member identifiers of the form MAC Address-Counter will be generated to aid in debugging. + - RekeyBehaviour (str(dontRekey | rekeyContinuous | rekeyFixedCount)): Determines the Rekey behavior. + - RekeyMode (str(timerBased | pNBased)): Rekey criteria. + - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/lag])): List of secondary (many to one) child layer protocols + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add( + self, + CakCount=None, + ConnectedVia=None, + KeyType=None, + MkaLifeTime=None, + Multiplier=None, + Name=None, + PeriodicRekeyAttempts=None, + PeriodicRekeyInterval=None, + RandomizeMemberIdentifier=None, + RekeyBehaviour=None, + RekeyMode=None, + StackedLayers=None, + ): + # type: (int, List[str], str, int, int, str, int, int, bool, str, str, List[str]) -> Mka + """Adds a new mka resource on the server and adds it to the container. + + Args + ---- + - CakCount (number): PSK Chain Size (Min 1, Max 10). + - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/lag])): List of layers this layer is used to connect with to the wire. + - KeyType (str(psk)): Indicates the source of CAK. + - MkaLifeTime (number): Indicates MKA Life Time of a Peer. + - Multiplier (number): Number of layer instances per parent instance (multiplier) + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - PeriodicRekeyAttempts (number): Number of times Rekey should be triggered. + - PeriodicRekeyInterval (number): Time interval between two Rekey triggers. + - RandomizeMemberIdentifier (bool): If this box is checked, then Ixia MKA devices will generate random member identifiers. Otherwise member identifiers of the form MAC Address-Counter will be generated to aid in debugging. + - RekeyBehaviour (str(dontRekey | rekeyContinuous | rekeyFixedCount)): Determines the Rekey behavior. + - RekeyMode (str(timerBased | pNBased)): Rekey criteria. + - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/lag])): List of secondary (many to one) child layer protocols + + Returns + ------- + - self: This instance with all currently retrieved mka resources using find and the newly added mka resources available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._create(self._map_locals(self._SDM_ATT_MAP, locals())) + + def remove(self): + """Deletes all the contained mka resources in this instance from the server. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + self._delete() + + def find( + self, + AssociationNumber=None, + CakCount=None, + ConnectedVia=None, + Count=None, + DelayProtectSimulation=None, + DescriptiveName=None, + ElectedKeyServer=None, + Errors=None, + KeyType=None, + MirroredMacAddr=None, + MkaLifeTime=None, + Multiplier=None, + Name=None, + PeriodicRekeyAttempts=None, + PeriodicRekeyInterval=None, + RandomizeMemberIdentifier=None, + RekeyBehaviour=None, + RekeyMode=None, + Sak=None, + SessionStatus=None, + StackedLayers=None, + StateCounts=None, + Status=None, + TxChannelCount=None, + ): + """Finds and retrieves mka resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve mka resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all mka resources from the server. + + Args + ---- + - AssociationNumber (list(str)): Displays the Association Number for the received SAK. + - CakCount (number): PSK Chain Size (Min 1, Max 10). + - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/lag])): List of layers this layer is used to connect with to the wire. + - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + - DelayProtectSimulation (list(str)): Displays the actual PN, simulated PN and the MKPDU message number. + - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + - ElectedKeyServer (list(str)): Denotes whether this device has been elected as a Key Server or not. + - Errors (list(dict(arg1:str[None | /api/v1/sessions/1/ixnetwork/],arg2:list[str]))): A list of errors that have occurred + - KeyType (str(psk)): Indicates the source of CAK. + - MirroredMacAddr (list(str)): MAC address of the Ethernet devices configured in the Ethernet stack. + - MkaLifeTime (number): Indicates MKA Life Time of a Peer. + - Multiplier (number): Number of layer instances per parent instance (multiplier) + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - PeriodicRekeyAttempts (number): Number of times Rekey should be triggered. + - PeriodicRekeyInterval (number): Time interval between two Rekey triggers. + - RandomizeMemberIdentifier (bool): If this box is checked, then Ixia MKA devices will generate random member identifiers. Otherwise member identifiers of the form MAC Address-Counter will be generated to aid in debugging. + - RekeyBehaviour (str(dontRekey | rekeyContinuous | rekeyFixedCount)): Determines the Rekey behavior. + - RekeyMode (str(timerBased | pNBased)): Rekey criteria. + - Sak (list(str)): Displays the SAK received from the Key Server. + - SessionStatus (list(str[down | notStarted | up])): Current state of protocol session: Not Started - session negotiation not started, the session is not active yet. Down - actively trying to bring up a protocol session, but negotiation is didn't successfully complete (yet). Up - session came up successfully. + - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/lag])): List of secondary (many to one) child layer protocols + - StateCounts (dict(total:number,notStarted:number,down:number,up:number)): A list of values that indicates the total number of sessions, the number of sessions not started, the number of sessions down and the number of sessions that are up + - Status (str(configured | error | mixed | notStarted | started | starting | stopping)): Running status of associated network element. Once in Started state, protocol sessions will begin to negotiate. + - TxChannelCount (number): Determines the number of Tx Channels configured for each device. + + Returns + ------- + - self: This instance with matching mka resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of mka data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the mka resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) + + def Abort(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the abort operation on the server. + + Abort CPF control plane (equals to demote to kUnconfigured state). + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + abort(async_operation=bool) + --------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + abort(SessionIndices=list, async_operation=bool) + ------------------------------------------------ + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + abort(SessionIndices=string, async_operation=bool) + -------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("abort", payload=payload, response_object=None) + + def ClearAllLearnedInfo(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the clearAllLearnedInfo operation on the server. + + Clear All Learned Info. + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + clearAllLearnedInfo(async_operation=bool) + ----------------------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + clearAllLearnedInfo(SessionIndices=list, async_operation=bool) + -------------------------------------------------------------- + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + clearAllLearnedInfo(SessionIndices=string, async_operation=bool) + ---------------------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + clearAllLearnedInfo(Arg2=list, async_operation=bool)list + -------------------------------------------------------- + - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each async action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "clearAllLearnedInfo", payload=payload, response_object=None + ) + + def GetLearnedInfo(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the getLearnedInfo operation on the server. + + Get Learned Info. + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + getLearnedInfo(async_operation=bool) + ------------------------------------ + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + getLearnedInfo(SessionIndices=list, async_operation=bool) + --------------------------------------------------------- + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + getLearnedInfo(SessionIndices=string, async_operation=bool) + ----------------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + getLearnedInfo(Arg2=list, async_operation=bool)list + --------------------------------------------------- + - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each async action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("getLearnedInfo", payload=payload, response_object=None) + + def PauseMKPDUTransmission(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the pauseMKPDUTransmission operation on the server. + + Pause MKPDU Transmission. + + pauseMKPDUTransmission(Arg2=list, async_operation=bool)list + ----------------------------------------------------------- + - Arg2 (list(number)): List of indices into the device group. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each async action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self.href} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "pauseMKPDUTransmission", payload=payload, response_object=None + ) + + def PausePeriodicRekey(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the PausePeriodicRekey operation on the server. + + Pause the periodic rekey timer if it is running. + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + PausePeriodicRekey(async_operation=bool) + ---------------------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + PausePeriodicRekey(SessionIndices=list, async_operation=bool) + ------------------------------------------------------------- + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + PausePeriodicRekey(SessionIndices=string, async_operation=bool) + --------------------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "PausePeriodicRekey", payload=payload, response_object=None + ) + + def PausePeriodicRekey(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the pausePeriodicRekey operation on the server. + + Pause the periodic rekey timer if it is running. + + pausePeriodicRekey(Arg2=list, async_operation=bool)list + ------------------------------------------------------- + - Arg2 (list(number)): List of indices into the device group. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each async action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self.href} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "pausePeriodicRekey", payload=payload, response_object=None + ) + + def RestartDown(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the restartDown operation on the server. + + Stop and start interfaces and sessions that are in Down state. + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + restartDown(async_operation=bool) + --------------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + restartDown(SessionIndices=list, async_operation=bool) + ------------------------------------------------------ + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + restartDown(SessionIndices=string, async_operation=bool) + -------------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("restartDown", payload=payload, response_object=None) + + def RestartPeriodicRekey(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the RestartPeriodicRekey operation on the server. + + Restart the periodic rekey timer if it was stopped. + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + RestartPeriodicRekey(async_operation=bool) + ------------------------------------------ + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + RestartPeriodicRekey(SessionIndices=list, async_operation=bool) + --------------------------------------------------------------- + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + RestartPeriodicRekey(SessionIndices=string, async_operation=bool) + ----------------------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "RestartPeriodicRekey", payload=payload, response_object=None + ) + + def RestartPeriodicRekey(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the restartPeriodicRekey operation on the server. + + Restart the periodic rekey timer if it was stopped. + + restartPeriodicRekey(Arg2=list, async_operation=bool)list + --------------------------------------------------------- + - Arg2 (list(number)): List of indices into the device group. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each async action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self.href} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "restartPeriodicRekey", payload=payload, response_object=None + ) + + def ResumeMKPDUTransmission(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the resumeMKPDUTransmission operation on the server. + + Resume MKPDU Transmission. + + resumeMKPDUTransmission(Arg2=list, async_operation=bool)list + ------------------------------------------------------------ + - Arg2 (list(number)): List of indices into the device group. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each async action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self.href} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "resumeMKPDUTransmission", payload=payload, response_object=None + ) + + def SimulateDelayedMACsecPacketsStart(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the simulateDelayedMACsecPacketsStart operation on the server. + + Start delay protect simulation. + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + simulateDelayedMACsecPacketsStart(async_operation=bool) + ------------------------------------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + simulateDelayedMACsecPacketsStart(SessionIndices=list, async_operation=bool) + ---------------------------------------------------------------------------- + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + simulateDelayedMACsecPacketsStart(SessionIndices=string, async_operation=bool) + ------------------------------------------------------------------------------ + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + simulateDelayedMACsecPacketsStart(Arg2=list, async_operation=bool)list + ---------------------------------------------------------------------- + - Arg2 (list(number)): List of indices into the device group. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each async action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "simulateDelayedMACsecPacketsStart", payload=payload, response_object=None + ) + + def SimulateDelayedMACsecPacketsStop(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the simulateDelayedMACsecPacketsStop operation on the server. + + Stop delay protect simulation. + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + simulateDelayedMACsecPacketsStop(async_operation=bool) + ------------------------------------------------------ + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + simulateDelayedMACsecPacketsStop(SessionIndices=list, async_operation=bool) + --------------------------------------------------------------------------- + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + simulateDelayedMACsecPacketsStop(SessionIndices=string, async_operation=bool) + ----------------------------------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + simulateDelayedMACsecPacketsStop(Arg2=list, async_operation=bool)list + --------------------------------------------------------------------- + - Arg2 (list(number)): List of indices into the device group. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each async action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "simulateDelayedMACsecPacketsStop", payload=payload, response_object=None + ) + + def Start(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the start operation on the server. + + Start CPF control plane (equals to promote to negotiated state). + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + start(async_operation=bool) + --------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + start(SessionIndices=list, async_operation=bool) + ------------------------------------------------ + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + start(SessionIndices=string, async_operation=bool) + -------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("start", payload=payload, response_object=None) + + def Stop(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the stop operation on the server. + + Stop CPF control plane (equals to demote to PreValidated-DoDDone state). + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + stop(async_operation=bool) + -------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + stop(SessionIndices=list, async_operation=bool) + ----------------------------------------------- + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + stop(SessionIndices=string, async_operation=bool) + ------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("stop", payload=payload, response_object=None) + + def TriggerRekey(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the triggerRekey operation on the server. + + Trigger a Rekey Event from Keysight emulated KeyServer. + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + triggerRekey(async_operation=bool) + ---------------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + triggerRekey(SessionIndices=list, async_operation=bool) + ------------------------------------------------------- + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + triggerRekey(SessionIndices=string, async_operation=bool) + --------------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + triggerRekey(Arg2=list, async_operation=bool)list + ------------------------------------------------- + - Arg2 (list(number)): List of indices into the device group. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each async action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("triggerRekey", payload=payload, response_object=None) + + def get_device_ids( + self, + PortNames=None, + ActiveDevice=None, + CipherSuite=None, + ConfidentialityOffset=None, + DelayProtect=None, + KeyDerivationFunction=None, + KeyServerPriority=None, + LlpnStep=None, + MacsecCapability=None, + MacsecDesired=None, + MemberIdentifier=None, + MkaHelloTime=None, + MkaVersion=None, + OlpnStep=None, + RekeyThresholdPN=None, + RekeyThresholdXPN=None, + SendICVIndicator=None, + StartingDistributedAN=None, + StartingKeyNumber=None, + StartingLLPN=None, + StartingOLPN=None, + SupportedCipherSuites=None, + ): + """Base class infrastructure that gets a list of mka device ids encapsulated by this object. + + Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. + + Args + ---- + - PortNames (str): optional regex of port names + - ActiveDevice (str): optional regex of activeDevice + - CipherSuite (str): optional regex of cipherSuite + - ConfidentialityOffset (str): optional regex of confidentialityOffset + - DelayProtect (str): optional regex of delayProtect + - KeyDerivationFunction (str): optional regex of keyDerivationFunction + - KeyServerPriority (str): optional regex of keyServerPriority + - LlpnStep (str): optional regex of llpnStep + - MacsecCapability (str): optional regex of macsecCapability + - MacsecDesired (str): optional regex of macsecDesired + - MemberIdentifier (str): optional regex of memberIdentifier + - MkaHelloTime (str): optional regex of mkaHelloTime + - MkaVersion (str): optional regex of mkaVersion + - OlpnStep (str): optional regex of olpnStep + - RekeyThresholdPN (str): optional regex of rekeyThresholdPN + - RekeyThresholdXPN (str): optional regex of rekeyThresholdXPN + - SendICVIndicator (str): optional regex of sendICVIndicator + - StartingDistributedAN (str): optional regex of startingDistributedAN + - StartingKeyNumber (str): optional regex of startingKeyNumber + - StartingLLPN (str): optional regex of startingLLPN + - StartingOLPN (str): optional regex of startingOLPN + - SupportedCipherSuites (str): optional regex of supportedCipherSuites + + Returns + ------- + - list(int): A list of device ids that meets the regex criteria provided in the method parameters + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._get_ngpf_device_ids(locals()) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/row_45173689e454bc6eba4167d6c8a281c5.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/row_45173689e454bc6eba4167d6c8a281c5.py new file mode 100644 index 000000000..2979e0fe7 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/row_45173689e454bc6eba4167d6c8a281c5.py @@ -0,0 +1,107 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class Row(Base): + """A row view of learned information. + The Row class encapsulates a list of row resources that are managed by the system. + A list of resources can be retrieved from the server using the Row.find() method. + """ + + __slots__ = () + _SDM_NAME = "row" + _SDM_ATT_MAP = { + "Value": "value", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(Row, self).__init__(parent, list_op) + + @property + def Value(self): + # type: () -> str + """ + Returns + ------- + - str: A learned information value + """ + return self._get_attribute(self._SDM_ATT_MAP["Value"]) + + def add(self): + """Adds a new row resource on the json, only valid with batch add utility + + Returns + ------- + - self: This instance with all currently retrieved row resources using find and the newly added row resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Value=None): + # type: (str) -> Row + """Finds and retrieves row resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve row resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all row resources from the server. + + Args + ---- + - Value (str): A learned information value + + Returns + ------- + - self: This instance with matching row resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of row data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the row resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/rxsakpool_cd41f87b984aa0c0b97c3462e829fc7c.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/rxsakpool_cd41f87b984aa0c0b97c3462e829fc7c.py new file mode 100644 index 000000000..6039d97f6 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/rxsakpool_cd41f87b984aa0c0b97c3462e829fc7c.py @@ -0,0 +1,216 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class RxSakPool(Base): + """Rx Channels configuration. + The RxSakPool class encapsulates a required rxSakPool resource which will be retrieved from the server every time the property is accessed. + """ + + __slots__ = () + _SDM_NAME = "rxSakPool" + _SDM_ATT_MAP = { + "Count": "count", + "DescriptiveName": "descriptiveName", + "Name": "name", + "RxSak128": "rxSak128", + "RxSak256": "rxSak256", + "RxSalt": "rxSalt", + "RxSsci": "rxSsci", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(RxSakPool, self).__init__(parent, list_op) + + @property + def Count(self): + # type: () -> int + """ + Returns + ------- + - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["Count"]) + + @property + def DescriptiveName(self): + # type: () -> str + """ + Returns + ------- + - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + """ + return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + @property + def RxSak128(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): 128 bit value of Secure Association Key with which DUT is expected to encrypt MACsec packets. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["RxSak128"])) + + @property + def RxSak256(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): 256 bit value of Secure Association Key with which DUT is expected to encrypt MACsec packets. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["RxSak256"])) + + @property + def RxSalt(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): 12 bytes Salt which DUT is expected to use for encrypting MACsec packets in case of XPN cipher suites. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["RxSalt"])) + + @property + def RxSsci(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): 4 bytes short SCI which DUT is expected to use for encrypting MACsec packets in case of XPN cipher suites. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["RxSsci"])) + + def update(self, Name=None): + # type: (str) -> RxSakPool + """Updates rxSakPool resource on the server. + + This method has some named parameters with a type: obj (Multivalue). + The Multivalue class has documentation that details the possible values for those named parameters. + + Args + ---- + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Count=None, DescriptiveName=None, Name=None): + # type: (int, str, str) -> RxSakPool + """Finds and retrieves rxSakPool resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve rxSakPool resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all rxSakPool resources from the server. + + Args + ---- + - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Returns + ------- + - self: This instance with matching rxSakPool resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of rxSakPool data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the rxSakPool resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) + + def get_device_ids( + self, PortNames=None, RxSak128=None, RxSak256=None, RxSalt=None, RxSsci=None + ): + """Base class infrastructure that gets a list of rxSakPool device ids encapsulated by this object. + + Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. + + Args + ---- + - PortNames (str): optional regex of port names + - RxSak128 (str): optional regex of rxSak128 + - RxSak256 (str): optional regex of rxSak256 + - RxSalt (str): optional regex of rxSalt + - RxSsci (str): optional regex of rxSsci + + Returns + ------- + - list(int): A list of device ids that meets the regex criteria provided in the method parameters + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._get_ngpf_device_ids(locals()) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/table_5db82318b9a3adae08e0db1b40a3ca80.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/table_5db82318b9a3adae08e0db1b40a3ca80.py new file mode 100644 index 000000000..99719e64c --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/table_5db82318b9a3adae08e0db1b40a3ca80.py @@ -0,0 +1,173 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class Table(Base): + """The node where learned information is grouped into tables or columns and rows. + The Table class encapsulates a list of table resources that are managed by the system. + A list of resources can be retrieved from the server using the Table.find() method. + """ + + __slots__ = () + _SDM_NAME = "table" + _SDM_ATT_MAP = { + "Actions": "actions", + "Columns": "columns", + "RowCount": "rowCount", + "Type": "type", + "Values": "values", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(Table, self).__init__(parent, list_op) + + @property + def Col(self): + """DEPRECATED + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.col_667991bd02f140c2b2287de796fe1846.Col): An instance of the Col class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.lag.col_667991bd02f140c2b2287de796fe1846 import ( + Col, + ) + + if len(self._object_properties) > 0: + if self._properties.get("Col", None) is not None: + return self._properties.get("Col") + return Col(self) + + @property + def Actions(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): The list of actions allowed on the learned information table + """ + return self._get_attribute(self._SDM_ATT_MAP["Actions"]) + + @property + def Columns(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): The list of columns in the learned information table + """ + return self._get_attribute(self._SDM_ATT_MAP["Columns"]) + + @property + def RowCount(self): + # type: () -> int + """ + Returns + ------- + - number: Number of rows in the learned information table + """ + return self._get_attribute(self._SDM_ATT_MAP["RowCount"]) + + @property + def Type(self): + # type: () -> str + """ + Returns + ------- + - str: Description of the learned information type + """ + return self._get_attribute(self._SDM_ATT_MAP["Type"]) + + @property + def Values(self): + """ + Returns + ------- + - list(list[str]): A list of rows of learned information values + """ + return self._get_attribute(self._SDM_ATT_MAP["Values"]) + + def add(self): + """Adds a new table resource on the json, only valid with batch add utility + + Returns + ------- + - self: This instance with all currently retrieved table resources using find and the newly added table resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Actions=None, Columns=None, RowCount=None, Type=None, Values=None): + """Finds and retrieves table resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve table resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all table resources from the server. + + Args + ---- + - Actions (list(str)): The list of actions allowed on the learned information table + - Columns (list(str)): The list of columns in the learned information table + - RowCount (number): Number of rows in the learned information table + - Type (str): Description of the learned information type + - Values (list(list[str])): A list of rows of learned information values + + Returns + ------- + - self: This instance with matching table resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of table data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the table resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/pce/pce_5defd13c57ea406c73fd4b2cb010a30f.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/txchannels_b00cc0f5ee44e7e1276269692ddc248a.py similarity index 61% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/pce/pce_5defd13c57ea406c73fd4b2cb010a30f.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/txchannels_b00cc0f5ee44e7e1276269692ddc248a.py index 0e3b8d7cb..116f471e1 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/pce/pce_5defd13c57ea406c73fd4b2cb010a30f.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/txchannels_b00cc0f5ee44e7e1276269692ddc248a.py @@ -27,77 +27,39 @@ from typing import List, Any, Union -class Pce(Base): - """PCE Port Specific Data - The Pce class encapsulates a required pce resource which will be retrieved from the server every time the property is accessed. +class TxChannels(Base): + """Tx Channel configuration. + The TxChannels class encapsulates a required txChannels resource which will be retrieved from the server every time the property is accessed. """ __slots__ = () - _SDM_NAME = "pce" + _SDM_NAME = "txChannels" _SDM_ATT_MAP = { - "BindingSIDDraftVersion": "bindingSIDDraftVersion", + "ActiveTxChannel": "activeTxChannel", "Count": "count", "DescriptiveName": "descriptiveName", "Name": "name", - "RowNames": "rowNames", + "PortId": "portId", + "StartingMessageNumber": "startingMessageNumber", + "SystemId": "systemId", } _SDM_ENUM_MAP = {} def __init__(self, parent, list_op=False): - super(Pce, self).__init__(parent, list_op) + super(TxChannels, self).__init__(parent, list_op) @property - def StartRate(self): - """ - Returns - ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.startrate.startrate_2bc83a4fb9730935e8259bdb40af2dc0.StartRate): An instance of the StartRate class - - Raises - ------ - - ServerError: The server has encountered an uncategorized error condition - """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.startrate.startrate_2bc83a4fb9730935e8259bdb40af2dc0 import ( - StartRate, - ) - - if len(self._object_properties) > 0: - if self._properties.get("StartRate", None) is not None: - return self._properties.get("StartRate") - return StartRate(self)._select() - - @property - def StopRate(self): - """ - Returns - ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.stoprate.stoprate_4ea9a1b38960d2b21012777131469a04.StopRate): An instance of the StopRate class - - Raises - ------ - - ServerError: The server has encountered an uncategorized error condition - """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.stoprate.stoprate_4ea9a1b38960d2b21012777131469a04 import ( - StopRate, - ) - - if len(self._object_properties) > 0: - if self._properties.get("StopRate", None) is not None: - return self._properties.get("StopRate") - return StopRate(self)._select() - - @property - def BindingSIDDraftVersion(self): + def ActiveTxChannel(self): # type: () -> 'Multivalue' """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Depending on this field backward compatibility will be given. All draft versions before IETF draft will follow existing implementation. New IETF draft will be using new implementation and TLV structure. + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines whether Tx Channel is active or not. """ from ixnetwork_restpy.multivalue import Multivalue return Multivalue( - self, self._get_attribute(self._SDM_ATT_MAP["BindingSIDDraftVersion"]) + self, self._get_attribute(self._SDM_ATT_MAP["ActiveTxChannel"]) ) @property @@ -136,18 +98,46 @@ def Name(self, value): self._set_attribute(self._SDM_ATT_MAP["Name"], value) @property - def RowNames(self): - # type: () -> List[str] + def PortId(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Port ID component of SCI with which MACsec traffic is transmitted. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["PortId"])) + + @property + def StartingMessageNumber(self): + # type: () -> 'Multivalue' """ Returns ------- - - list(str): Name of rows + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the starting message number. """ - return self._get_attribute(self._SDM_ATT_MAP["RowNames"]) + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["StartingMessageNumber"]) + ) + + @property + def SystemId(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): System Identifier component of the SCI field with which MACsec traffic is transmitted. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["SystemId"])) def update(self, Name=None): - # type: (str) -> Pce - """Updates pce resource on the server. + # type: (str) -> TxChannels + """Updates txChannels resource on the server. This method has some named parameters with a type: obj (Multivalue). The Multivalue class has documentation that details the possible values for those named parameters. @@ -162,24 +152,23 @@ def update(self, Name=None): """ return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) - def find(self, Count=None, DescriptiveName=None, Name=None, RowNames=None): - # type: (int, str, str, List[str]) -> Pce - """Finds and retrieves pce resources from the server. + def find(self, Count=None, DescriptiveName=None, Name=None): + # type: (int, str, str) -> TxChannels + """Finds and retrieves txChannels resources from the server. - All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve pce resources from the server. + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve txChannels resources from the server. To retrieve an exact match ensure the parameter value starts with ^ and ends with $ - By default the find method takes no parameters and will retrieve all pce resources from the server. + By default the find method takes no parameters and will retrieve all txChannels resources from the server. Args ---- - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. - Name (str): Name of NGPF element, guaranteed to be unique in Scenario - - RowNames (list(str)): Name of rows Returns ------- - - self: This instance with matching pce resources retrieved from the server available through an iterator or index + - self: This instance with matching txChannels resources retrieved from the server available through an iterator or index Raises ------ @@ -188,7 +177,7 @@ def find(self, Count=None, DescriptiveName=None, Name=None, RowNames=None): return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) def read(self, href): - """Retrieves a single instance of pce data from the server. + """Retrieves a single instance of txChannels data from the server. Args ---- @@ -196,7 +185,7 @@ def read(self, href): Returns ------- - - self: This instance with the pce resources from the server available through an iterator or index + - self: This instance with the txChannels resources from the server available through an iterator or index Raises ------ @@ -205,15 +194,25 @@ def read(self, href): """ return self._read(href) - def get_device_ids(self, PortNames=None, BindingSIDDraftVersion=None): - """Base class infrastructure that gets a list of pce device ids encapsulated by this object. + def get_device_ids( + self, + PortNames=None, + ActiveTxChannel=None, + PortId=None, + StartingMessageNumber=None, + SystemId=None, + ): + """Base class infrastructure that gets a list of txChannels device ids encapsulated by this object. Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. Args ---- - PortNames (str): optional regex of port names - - BindingSIDDraftVersion (str): optional regex of bindingSIDDraftVersion + - ActiveTxChannel (str): optional regex of activeTxChannel + - PortId (str): optional regex of portId + - StartingMessageNumber (str): optional regex of startingMessageNumber + - SystemId (str): optional regex of systemId Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/pcc/pcc_91c1343cca1ebf407382f361cdaac3e7.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/txsakpool_d388a9eb0094019eed187e78ca376c92.py similarity index 55% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/pcc/pcc_91c1343cca1ebf407382f361cdaac3e7.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/txsakpool_d388a9eb0094019eed187e78ca376c92.py index 1482605ff..1b52dc9ef 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/globals/topology/pcc/pcc_91c1343cca1ebf407382f361cdaac3e7.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/lag/txsakpool_d388a9eb0094019eed187e78ca376c92.py @@ -27,95 +27,52 @@ from typing import List, Any, Union -class Pcc(Base): - """PCC Port Specific Data - The Pcc class encapsulates a required pcc resource which will be retrieved from the server every time the property is accessed. +class TxSakPool(Base): + """Tx SAKs configuration. + The TxSakPool class encapsulates a required txSakPool resource which will be retrieved from the server every time the property is accessed. """ __slots__ = () - _SDM_NAME = "pcc" + _SDM_NAME = "txSakPool" _SDM_ATT_MAP = { - "BackupPCEOperationMode": "backupPCEOperationMode", - "BindingSIDDraftVersion": "bindingSIDDraftVersion", + "ActiveSak": "activeSak", + "AnInUse": "anInUse", "Count": "count", "DescriptiveName": "descriptiveName", - "LspDelegationDelay": "lspDelegationDelay", "Name": "name", - "PcePathComputationMode": "pcePathComputationMode", - "RowNames": "rowNames", + "TxSak128": "txSak128", + "TxSak256": "txSak256", + "TxSalt": "txSalt", + "TxSsci": "txSsci", } _SDM_ENUM_MAP = {} def __init__(self, parent, list_op=False): - super(Pcc, self).__init__(parent, list_op) + super(TxSakPool, self).__init__(parent, list_op) @property - def StartRate(self): - """ - Returns - ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.startrate.startrate_2bc83a4fb9730935e8259bdb40af2dc0.StartRate): An instance of the StartRate class - - Raises - ------ - - ServerError: The server has encountered an uncategorized error condition - """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.startrate.startrate_2bc83a4fb9730935e8259bdb40af2dc0 import ( - StartRate, - ) - - if len(self._object_properties) > 0: - if self._properties.get("StartRate", None) is not None: - return self._properties.get("StartRate") - return StartRate(self)._select() - - @property - def StopRate(self): - """ - Returns - ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.stoprate.stoprate_4ea9a1b38960d2b21012777131469a04.StopRate): An instance of the StopRate class - - Raises - ------ - - ServerError: The server has encountered an uncategorized error condition - """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.globals.topology.ethernet.stoprate.stoprate_4ea9a1b38960d2b21012777131469a04 import ( - StopRate, - ) - - if len(self._object_properties) > 0: - if self._properties.get("StopRate", None) is not None: - return self._properties.get("StopRate") - return StopRate(self)._select() - - @property - def BackupPCEOperationMode(self): + def ActiveSak(self): # type: () -> 'Multivalue' """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Backup PCE Operation Mode + - obj(ixnetwork_restpy.multivalue.Multivalue): Points to the SAK value with which packets are currently getting encrypted. """ from ixnetwork_restpy.multivalue import Multivalue - return Multivalue( - self, self._get_attribute(self._SDM_ATT_MAP["BackupPCEOperationMode"]) - ) + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["ActiveSak"])) @property - def BindingSIDDraftVersion(self): + def AnInUse(self): # type: () -> 'Multivalue' """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Depending on this field backward compatibility will be given. All draft versions before IETF draft will follow existing implementation. New IETF draft will be using new implementation and TLV structure. + - obj(ixnetwork_restpy.multivalue.Multivalue): Shows the current AN value in use. """ from ixnetwork_restpy.multivalue import Multivalue - return Multivalue( - self, self._get_attribute(self._SDM_ATT_MAP["BindingSIDDraftVersion"]) - ) + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["AnInUse"])) @property def Count(self): @@ -138,61 +95,71 @@ def DescriptiveName(self): return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) @property - def LspDelegationDelay(self): + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + @property + def TxSak128(self): # type: () -> 'Multivalue' """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Time in seconds before PCC distributes LSP delegation at startup. + - obj(ixnetwork_restpy.multivalue.Multivalue): 128 bit value of Secure Association Key used for encryption of transmitted MACsec packets. """ from ixnetwork_restpy.multivalue import Multivalue - return Multivalue( - self, self._get_attribute(self._SDM_ATT_MAP["LspDelegationDelay"]) - ) + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["TxSak128"])) @property - def Name(self): - # type: () -> str + def TxSak256(self): + # type: () -> 'Multivalue' """ Returns ------- - - str: Name of NGPF element, guaranteed to be unique in Scenario + - obj(ixnetwork_restpy.multivalue.Multivalue): 256 bit value of Secure Association Key with which DUT is expected to encrypt MACsec packets. """ - return self._get_attribute(self._SDM_ATT_MAP["Name"]) + from ixnetwork_restpy.multivalue import Multivalue - @Name.setter - def Name(self, value): - # type: (str) -> None - self._set_attribute(self._SDM_ATT_MAP["Name"], value) + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["TxSak256"])) @property - def PcePathComputationMode(self): + def TxSalt(self): # type: () -> 'Multivalue' """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): PCE Path Computation Mode + - obj(ixnetwork_restpy.multivalue.Multivalue): 12 bytes Salt used for encryption of transmitted MACsec packets in case of XPN cipher suites. """ from ixnetwork_restpy.multivalue import Multivalue - return Multivalue( - self, self._get_attribute(self._SDM_ATT_MAP["PcePathComputationMode"]) - ) + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["TxSalt"])) @property - def RowNames(self): - # type: () -> List[str] + def TxSsci(self): + # type: () -> 'Multivalue' """ Returns ------- - - list(str): Name of rows + - obj(ixnetwork_restpy.multivalue.Multivalue): 4 bytes short SCI used for encryption of transmitted MACsec packets in case of XPN cipher suites. """ - return self._get_attribute(self._SDM_ATT_MAP["RowNames"]) + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["TxSsci"])) def update(self, Name=None): - # type: (str) -> Pcc - """Updates pcc resource on the server. + # type: (str) -> TxSakPool + """Updates txSakPool resource on the server. This method has some named parameters with a type: obj (Multivalue). The Multivalue class has documentation that details the possible values for those named parameters. @@ -207,24 +174,23 @@ def update(self, Name=None): """ return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) - def find(self, Count=None, DescriptiveName=None, Name=None, RowNames=None): - # type: (int, str, str, List[str]) -> Pcc - """Finds and retrieves pcc resources from the server. + def find(self, Count=None, DescriptiveName=None, Name=None): + # type: (int, str, str) -> TxSakPool + """Finds and retrieves txSakPool resources from the server. - All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve pcc resources from the server. + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve txSakPool resources from the server. To retrieve an exact match ensure the parameter value starts with ^ and ends with $ - By default the find method takes no parameters and will retrieve all pcc resources from the server. + By default the find method takes no parameters and will retrieve all txSakPool resources from the server. Args ---- - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. - Name (str): Name of NGPF element, guaranteed to be unique in Scenario - - RowNames (list(str)): Name of rows Returns ------- - - self: This instance with matching pcc resources retrieved from the server available through an iterator or index + - self: This instance with matching txSakPool resources retrieved from the server available through an iterator or index Raises ------ @@ -233,7 +199,7 @@ def find(self, Count=None, DescriptiveName=None, Name=None, RowNames=None): return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) def read(self, href): - """Retrieves a single instance of pcc data from the server. + """Retrieves a single instance of txSakPool data from the server. Args ---- @@ -241,7 +207,7 @@ def read(self, href): Returns ------- - - self: This instance with the pcc resources from the server available through an iterator or index + - self: This instance with the txSakPool resources from the server available through an iterator or index Raises ------ @@ -253,22 +219,26 @@ def read(self, href): def get_device_ids( self, PortNames=None, - BackupPCEOperationMode=None, - BindingSIDDraftVersion=None, - LspDelegationDelay=None, - PcePathComputationMode=None, + ActiveSak=None, + AnInUse=None, + TxSak128=None, + TxSak256=None, + TxSalt=None, + TxSsci=None, ): - """Base class infrastructure that gets a list of pcc device ids encapsulated by this object. + """Base class infrastructure that gets a list of txSakPool device ids encapsulated by this object. Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. Args ---- - PortNames (str): optional regex of port names - - BackupPCEOperationMode (str): optional regex of backupPCEOperationMode - - BindingSIDDraftVersion (str): optional regex of bindingSIDDraftVersion - - LspDelegationDelay (str): optional regex of lspDelegationDelay - - PcePathComputationMode (str): optional regex of pcePathComputationMode + - ActiveSak (str): optional regex of activeSak + - AnInUse (str): optional regex of anInUse + - TxSak128 (str): optional regex of txSak128 + - TxSak256 (str): optional regex of txSak256 + - TxSalt (str): optional regex of txSalt + - TxSsci (str): optional regex of txSsci Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/locations/locations.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/locations/locations.py index ffbd52e22..dd7faad07 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/locations/locations.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/locations/locations.py @@ -56,6 +56,7 @@ class Locations(Base): "ProtocolBuildNumber": "protocolBuildNumber", "SequenceId": "sequenceId", "State": "state", + "StateV2": "stateV2", } _SDM_ENUM_MAP = { "chainTopology": ["daisy", "none", "star"], @@ -72,6 +73,14 @@ class Locations(Base): ], "osType": ["linux", "unknown", "windows"], "state": ["down", "down", "polling", "polling", "polling", "ready"], + "stateV2": [ + "connectError", + "down", + "notConnected", + "polling", + "pollingWait", + "ready", + ], } def __init__(self, parent, list_op=False): @@ -123,7 +132,7 @@ def CableLength(self): """ Returns ------- - - number: + - number: Specifies the length of the cable between two adjacent devices. Must be set only after the device hostname has been set and committed on the current device. """ return self._get_attribute(self._SDM_ATT_MAP["CableLength"]) @@ -138,7 +147,7 @@ def ChainTopology(self): """ Returns ------- - - str(daisy | none | star): + - str(daisy | none | star): The chain topology type. This must be defined on the primary device. It must be defined only after the device host name has been specified and applied on the current device. For legacy device chains, the daisy chainTopology should be indicated. """ return self._get_attribute(self._SDM_ATT_MAP["ChainTopology"]) @@ -153,7 +162,7 @@ def ConnectRetries(self): """ Returns ------- - - number: + - number: The number of time the client attempted to re-connect with the device. (read only) """ return self._get_attribute(self._SDM_ATT_MAP["ConnectRetries"]) @@ -163,7 +172,7 @@ def DeviceType(self): """ Returns ------- - - str: + - str: The type of device. """ return self._get_attribute(self._SDM_ATT_MAP["DeviceType"]) @@ -173,7 +182,7 @@ def ErrorDescription(self): """ Returns ------- - - str: + - str: Connection error description. """ return self._get_attribute(self._SDM_ATT_MAP["ErrorDescription"]) @@ -183,7 +192,7 @@ def ErrorState(self): """ Returns ------- - - str(ConnectError | DuplicateChassis | IncompatibleIxOS | MultipleNics | NoCardsFound | NoError | NoLicenseFound | NonAppliance | NonLinuxChassis): + - str(ConnectError | DuplicateChassis | IncompatibleIxOS | MultipleNics | NoCardsFound | NoError | NoLicenseFound | NonAppliance | NonLinuxChassis): Device error state. """ return self._get_attribute(self._SDM_ATT_MAP["ErrorState"]) @@ -193,7 +202,7 @@ def Hostname(self): """ Returns ------- - - str: + - str: The hostname or IP address associated with the device. """ return self._get_attribute(self._SDM_ATT_MAP["Hostname"]) @@ -208,7 +217,7 @@ def Ip(self): """ Returns ------- - - str: + - str: The IP address associated with the device. """ return self._get_attribute(self._SDM_ATT_MAP["Ip"]) @@ -218,7 +227,7 @@ def IsMaster(self): """DEPRECATED Returns ------- - - bool: + - bool: Specifies whether this device is a primary of a secondary in a chain. There can be only one primary device in a chain. NOTE: The primary is automatically assigned based on cable connections. """ return self._get_attribute(self._SDM_ATT_MAP["IsMaster"]) @@ -228,7 +237,7 @@ def IsPrimary(self): """ Returns ------- - - bool: Specifies whether this chassis is a primary of a secondary in a chain. + - bool: Specifies whether this device is a primary of a secondary in a chain. """ return self._get_attribute(self._SDM_ATT_MAP["IsPrimary"]) @@ -238,7 +247,7 @@ def IxnBuildNumber(self): """ Returns ------- - - str: + - str: IxNetwork build number. """ return self._get_attribute(self._SDM_ATT_MAP["IxnBuildNumber"]) @@ -248,7 +257,7 @@ def IxosBuildNumber(self): """ Returns ------- - - str: + - str: The IxOS version running on the device in use. """ return self._get_attribute(self._SDM_ATT_MAP["IxosBuildNumber"]) @@ -258,7 +267,7 @@ def LicenseErrors(self): """ Returns ------- - - list(str): + - list(str): Shows the licensing errors that occurred due to licensing problems. """ return self._get_attribute(self._SDM_ATT_MAP["LicenseErrors"]) @@ -268,7 +277,7 @@ def MasterDevice(self): """DEPRECATED Returns ------- - - str: + - str: Specify the hostname of the primary device on a secondary device. Must be left blank on primary. Must be set only after the device hostname has been set and committed on the current device. """ return self._get_attribute(self._SDM_ATT_MAP["MasterDevice"]) @@ -283,7 +292,7 @@ def OsType(self): """ Returns ------- - - str(linux | unknown | windows): + - str(linux | unknown | windows): Device OS type. """ return self._get_attribute(self._SDM_ATT_MAP["OsType"]) @@ -308,7 +317,7 @@ def ProtocolBuildNumber(self): """ Returns ------- - - str: + - str: The Protocols version of the device in use. """ return self._get_attribute(self._SDM_ATT_MAP["ProtocolBuildNumber"]) @@ -318,7 +327,7 @@ def SequenceId(self): """ Returns ------- - - number: + - number: Indicates the order at which the device in a chain are pulsed by IxOS. Star topology chains are automatically setting this value. Must be set only after the device hostname has been set and committed on the current device. """ return self._get_attribute(self._SDM_ATT_MAP["SequenceId"]) @@ -330,13 +339,23 @@ def SequenceId(self, value): @property def State(self): # type: () -> str - """ + """DEPRECATED Returns ------- - - str(down | down | polling | polling | polling | ready): + - str(down | down | polling | polling | polling | ready): The following states can be read from the port: polling, ready, and down. """ return self._get_attribute(self._SDM_ATT_MAP["State"]) + @property + def StateV2(self): + # type: () -> str + """ + Returns + ------- + - str(connectError | down | notConnected | polling | pollingWait | ready): The following states can be read from the port: polling, notConnected, pollingWait, ready, down, and connectError. + """ + return self._get_attribute(self._SDM_ATT_MAP["StateV2"]) + def update( self, CableLength=None, @@ -351,12 +370,12 @@ def update( Args ---- - - CableLength (number): - - ChainTopology (str(daisy | none | star)): - - Hostname (str): - - MasterDevice (str): + - CableLength (number): Specifies the length of the cable between two adjacent devices. Must be set only after the device hostname has been set and committed on the current device. + - ChainTopology (str(daisy | none | star)): The chain topology type. This must be defined on the primary device. It must be defined only after the device host name has been specified and applied on the current device. For legacy device chains, the daisy chainTopology should be indicated. + - Hostname (str): The hostname or IP address associated with the device. + - MasterDevice (str): Specify the hostname of the primary device on a secondary device. Must be left blank on primary. Must be set only after the device hostname has been set and committed on the current device. - PrimaryDevice (str): Specify the hostname of the primary chassis on a secondary chassis. Must be left blank on primary. Must be set only after the chassis hostname has been set and committed on the current chassis. - - SequenceId (number): + - SequenceId (number): Indicates the order at which the device in a chain are pulsed by IxOS. Star topology chains are automatically setting this value. Must be set only after the device hostname has been set and committed on the current device. Raises ------ @@ -378,12 +397,12 @@ def add( Args ---- - - CableLength (number): - - ChainTopology (str(daisy | none | star)): - - Hostname (str): - - MasterDevice (str): + - CableLength (number): Specifies the length of the cable between two adjacent devices. Must be set only after the device hostname has been set and committed on the current device. + - ChainTopology (str(daisy | none | star)): The chain topology type. This must be defined on the primary device. It must be defined only after the device host name has been specified and applied on the current device. For legacy device chains, the daisy chainTopology should be indicated. + - Hostname (str): The hostname or IP address associated with the device. + - MasterDevice (str): Specify the hostname of the primary device on a secondary device. Must be left blank on primary. Must be set only after the device hostname has been set and committed on the current device. - PrimaryDevice (str): Specify the hostname of the primary chassis on a secondary chassis. Must be left blank on primary. Must be set only after the chassis hostname has been set and committed on the current chassis. - - SequenceId (number): + - SequenceId (number): Indicates the order at which the device in a chain are pulsed by IxOS. Star topology chains are automatically setting this value. Must be set only after the device hostname has been set and committed on the current device. Returns ------- @@ -426,8 +445,9 @@ def find( ProtocolBuildNumber=None, SequenceId=None, State=None, + StateV2=None, ): - # type: (int, str, int, str, str, str, str, str, bool, bool, str, str, List[str], str, str, str, str, int, str) -> Locations + # type: (int, str, int, str, str, str, str, str, bool, bool, str, str, List[str], str, str, str, str, int, str, str) -> Locations """Finds and retrieves locations resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve locations resources from the server. @@ -436,25 +456,26 @@ def find( Args ---- - - CableLength (number): - - ChainTopology (str(daisy | none | star)): - - ConnectRetries (number): - - DeviceType (str): - - ErrorDescription (str): - - ErrorState (str(ConnectError | DuplicateChassis | IncompatibleIxOS | MultipleNics | NoCardsFound | NoError | NoLicenseFound | NonAppliance | NonLinuxChassis)): - - Hostname (str): - - Ip (str): - - IsMaster (bool): - - IsPrimary (bool): Specifies whether this chassis is a primary of a secondary in a chain. - - IxnBuildNumber (str): - - IxosBuildNumber (str): - - LicenseErrors (list(str)): - - MasterDevice (str): - - OsType (str(linux | unknown | windows)): + - CableLength (number): Specifies the length of the cable between two adjacent devices. Must be set only after the device hostname has been set and committed on the current device. + - ChainTopology (str(daisy | none | star)): The chain topology type. This must be defined on the primary device. It must be defined only after the device host name has been specified and applied on the current device. For legacy device chains, the daisy chainTopology should be indicated. + - ConnectRetries (number): The number of time the client attempted to re-connect with the device. (read only) + - DeviceType (str): The type of device. + - ErrorDescription (str): Connection error description. + - ErrorState (str(ConnectError | DuplicateChassis | IncompatibleIxOS | MultipleNics | NoCardsFound | NoError | NoLicenseFound | NonAppliance | NonLinuxChassis)): Device error state. + - Hostname (str): The hostname or IP address associated with the device. + - Ip (str): The IP address associated with the device. + - IsMaster (bool): Specifies whether this device is a primary of a secondary in a chain. There can be only one primary device in a chain. NOTE: The primary is automatically assigned based on cable connections. + - IsPrimary (bool): Specifies whether this device is a primary of a secondary in a chain. + - IxnBuildNumber (str): IxNetwork build number. + - IxosBuildNumber (str): The IxOS version running on the device in use. + - LicenseErrors (list(str)): Shows the licensing errors that occurred due to licensing problems. + - MasterDevice (str): Specify the hostname of the primary device on a secondary device. Must be left blank on primary. Must be set only after the device hostname has been set and committed on the current device. + - OsType (str(linux | unknown | windows)): Device OS type. - PrimaryDevice (str): Specify the hostname of the primary chassis on a secondary chassis. Must be left blank on primary. Must be set only after the chassis hostname has been set and committed on the current chassis. - - ProtocolBuildNumber (str): - - SequenceId (number): - - State (str(down | down | polling | polling | polling | ready)): + - ProtocolBuildNumber (str): The Protocols version of the device in use. + - SequenceId (number): Indicates the order at which the device in a chain are pulsed by IxOS. Star topology chains are automatically setting this value. Must be set only after the device hostname has been set and committed on the current device. + - State (str(down | down | polling | polling | polling | ready)): The following states can be read from the port: polling, ready, and down. + - StateV2 (str(connectError | down | notConnected | polling | pollingWait | ready)): The following states can be read from the port: polling, notConnected, pollingWait, ready, down, and connectError. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/locations/ports/ports.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/locations/ports/ports.py index 8d80a4cac..4cd9d3bc7 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/locations/ports/ports.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/locations/ports/ports.py @@ -79,7 +79,9 @@ class Ports(Base): "krakenTwoByOneHundredGigFanOut", "krakenFourByFiftyGigFanOut", "aresOneOneByFourHundredGigNonFanOut", + "aresOneOneByFourHundredGigMacSecNonFanOut", "aresOneTwoByTwoHundredGigFanOut", + "aresOneTwoByTwoHundredGigMacSecFanOut", "aresOneFourByOneHundredGigFanOut", "aresOneFourByOneHundredGigMacSecFanOut", "aresOneEightByFiftyGigFanOut", @@ -92,6 +94,7 @@ class Ports(Base): "novus5GOneByTwentyFiveGigNonFanOut", "novus5GOneByFiftyGigNonFanOut", "novus5GOneByHundredGigNonFanOut", + "novus5GOneByHundredGigNonFanOutHighStream", "starTwoByFourHundredGigNonFannedOutPAM4", "starFourByTwoHundredGigFannedOutPAM4", "starEightByHundredGigFannedOutPAM4", @@ -101,11 +104,32 @@ class Ports(Base): "starFourByFortyGigFannedOutNRZ", "starSixteenByTwentyFiveGigFannedOutNRZ", "starSixteenByTenGigFannedOutNRZ", + "starFourByHundredGigFannedOutPAM4HalfDensityHighStream", + "starEightByFiftyGigFannedOutPAM4HalfDensityHighStream", + "starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream", + "starEightByTenGigFannedOutNRZHalfDensityHighStream", "novusHundredGigNonFanOutHighStream", "novusFourByTwentyFiveGigNonFanOutHighStream", "novusTwoByFiftyGigNonFanOutHighStream", "novusOneByFortyGigNonFanOutHighStream", "novusFourByTenGigNonFanOutHighStream", + "ravenEightByHundredGigFannedOutPAM4", + "ravenFourByTwoHundredGigFannedOutPAM4", + "ravenTwoByFourHundredGigFannedOutPAM4", + "ravenOneByEightHundredGigNonFannedOutPAM4", + "aresOneEightHundredQddCEightByHundredGigFannedOutPAM4", + "aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4", + "aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4", + "aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4", + "rangerHundredGig", + "rangerFiftyGig", + "rangerFourtyGig", + "rangerTwentyFiveGig", + "rangerTenGig", + "aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4", + "aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4", + "aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4", + "aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4", "notApplicable", ], } @@ -119,7 +143,7 @@ def Description(self): """ Returns ------- - - str: + - str: Port description. """ return self._get_attribute(self._SDM_ATT_MAP["Description"]) @@ -129,7 +153,7 @@ def IsAvailable(self): """ Returns ------- - - bool: + - bool: Is port ownership with current user. """ return self._get_attribute(self._SDM_ATT_MAP["IsAvailable"]) @@ -139,7 +163,7 @@ def IsBusy(self): """ Returns ------- - - bool: + - bool: Is port in transition, being connected or released. """ return self._get_attribute(self._SDM_ATT_MAP["IsBusy"]) @@ -149,7 +173,7 @@ def IsLinkUp(self): """ Returns ------- - - bool: + - bool: Is port in link up state. """ return self._get_attribute(self._SDM_ATT_MAP["IsLinkUp"]) @@ -159,7 +183,7 @@ def Location(self): """ Returns ------- - - str: + - str: Connecton information of this port. When location is assigned IxNetwork will try to connect to the device if the device is not connected. """ return self._get_attribute(self._SDM_ATT_MAP["Location"]) @@ -169,7 +193,7 @@ def Owner(self): """ Returns ------- - - str: + - str: Port owner. """ return self._get_attribute(self._SDM_ATT_MAP["Owner"]) @@ -229,7 +253,7 @@ def ResourceMode(self): """ Returns ------- - - str(normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | notApplicable): + - str(normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4 | notApplicable): Gets the current port resource group mode. """ return self._get_attribute(self._SDM_ATT_MAP["ResourceMode"]) @@ -270,18 +294,18 @@ def find( Args ---- - - Description (str): - - IsAvailable (bool): - - IsBusy (bool): - - IsLinkUp (bool): - - Location (str): - - Owner (str): + - Description (str): Port description. + - IsAvailable (bool): Is port ownership with current user. + - IsBusy (bool): Is port in transition, being connected or released. + - IsLinkUp (bool): Is port in link up state. + - Location (str): Connecton information of this port. When location is assigned IxNetwork will try to connect to the device if the device is not connected. + - Owner (str): Port owner. - PeerPortDescription (str): Discovered peer port description. - PeerPortId (str): The port ID of the discovered peer port. - PeerSystemIp (str): The IP address of the discovered peer system. - PeerSystemMac (str): The MAC address of the discovered peer system. - PeerSystemName (str): The system name of the discovered peer. - - ResourceMode (str(normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | notApplicable)): + - ResourceMode (str(normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4 | notApplicable)): Gets the current port resource group mode. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/locations/resourcegroups/resourcegroups.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/locations/resourcegroups/resourcegroups.py index fe1fd2500..f5c0c39c6 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/locations/resourcegroups/resourcegroups.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/locations/resourcegroups/resourcegroups.py @@ -51,7 +51,7 @@ def AvailableResourceModes(self): """ Returns ------- - - list(str[normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream]): + - list(str[normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4]): Gets the supported resource group modes. """ return self._get_attribute(self._SDM_ATT_MAP["AvailableResourceModes"]) @@ -61,7 +61,7 @@ def Card(self): """ Returns ------- - - str: + - str: Card id """ return self._get_attribute(self._SDM_ATT_MAP["Card"]) @@ -71,7 +71,7 @@ def FrontPanelPorts(self): """ Returns ------- - - list(number): + - list(number): Gets the device front panel port ids. """ return self._get_attribute(self._SDM_ATT_MAP["FrontPanelPorts"]) @@ -98,9 +98,9 @@ def find(self, AvailableResourceModes=None, Card=None, FrontPanelPorts=None): Args ---- - - AvailableResourceModes (list(str[normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream])): - - Card (str): - - FrontPanelPorts (list(number)): + - AvailableResourceModes (list(str[normal | tenGig | fortyGig | singleMode | dualMode | hundredGigNonFanOut | fortyGigFanOut | threeByTenGigFanOut | eightByTenGigFanOut | fourByTwentyFiveGigNonFanOut | twoByTwentyFiveGigNonFanOut | oneByFiftyGigNonFanOut | fortyGigNonFanOut | oneByTenGigFanOut | fourByTenGigFanOut | incompatibleMode | hundredGigCapturePlayback | fortyGigCapturePlayback | novusHundredGigNonFanOut | novusFourByTwentyFiveGigNonFanOut | novusTwoByFiftyGigNonFanOut | novusOneByFortyGigNonFanOut | novusFourByTenGigNonFanOut | krakenOneByFourHundredGigNonFanOut | krakenOneByTwoHundredGigNonFanOut | krakenTwoByOneHundredGigFanOut | krakenFourByFiftyGigFanOut | aresOneOneByFourHundredGigNonFanOut | aresOneOneByFourHundredGigMacSecNonFanOut | aresOneTwoByTwoHundredGigFanOut | aresOneTwoByTwoHundredGigMacSecFanOut | aresOneFourByOneHundredGigFanOut | aresOneFourByOneHundredGigMacSecFanOut | aresOneEightByFiftyGigFanOut | uhdOneHundredEightByHundredGigNonFanOut | uhdOneHundredEightByFortyGigNonFanOut | uhdOneHundredSixteenByFiftyGigFanOut | uhdOneHundredThirtyTwoByTwentyFiveGigFanOut | uhdOneHundredThirtyTwoByTenGigFanOut | novus5GOneByTenGigNonFanOut | novus5GOneByTwentyFiveGigNonFanOut | novus5GOneByFiftyGigNonFanOut | novus5GOneByHundredGigNonFanOut | novus5GOneByHundredGigNonFanOutHighStream | starTwoByFourHundredGigNonFannedOutPAM4 | starFourByTwoHundredGigFannedOutPAM4 | starEightByHundredGigFannedOutPAM4 | starFourByHundredGigFannedOutNRZ | starSixteenByFiftyGigFannedOutPAM4 | starEightByFiftyGigFannedOutNRZ | starFourByFortyGigFannedOutNRZ | starSixteenByTwentyFiveGigFannedOutNRZ | starSixteenByTenGigFannedOutNRZ | starFourByHundredGigFannedOutPAM4HalfDensityHighStream | starEightByFiftyGigFannedOutPAM4HalfDensityHighStream | starEightByTwentyFiveGigFannedOutNRZHalfDensityHighStream | starEightByTenGigFannedOutNRZHalfDensityHighStream | novusHundredGigNonFanOutHighStream | novusFourByTwentyFiveGigNonFanOutHighStream | novusTwoByFiftyGigNonFanOutHighStream | novusOneByFortyGigNonFanOutHighStream | novusFourByTenGigNonFanOutHighStream | ravenEightByHundredGigFannedOutPAM4 | ravenFourByTwoHundredGigFannedOutPAM4 | ravenTwoByFourHundredGigFannedOutPAM4 | ravenOneByEightHundredGigNonFannedOutPAM4 | aresOneEightHundredQddCEightByHundredGigFannedOutPAM4 | aresOneEightHundredQddCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredQddCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredQddCOneByEightHundredGigNonFannedOutPAM4 | rangerHundredGig | rangerFiftyGig | rangerFourtyGig | rangerTwentyFiveGig | rangerTenGig | aresOneEightHundredOsfpCEightByHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCFourByTwoHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCTwoByFourHundredGigFannedOutPAM4 | aresOneEightHundredOsfpCOneByEightHundredGigNonFannedOutPAM4])): Gets the supported resource group modes. + - Card (str): Card id + - FrontPanelPorts (list(number)): Gets the device front panel port ids. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/globals_605c8d39970b93a1aba6b6a97467871c.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/globals_69a5d2805874fa9bd7dc448d50ded673.py similarity index 97% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/globals_605c8d39970b93a1aba6b6a97467871c.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/globals_69a5d2805874fa9bd7dc448d50ded673.py index a78ba7b6b..669de0503 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/globals_605c8d39970b93a1aba6b6a97467871c.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/globals_69a5d2805874fa9bd7dc448d50ded673.py @@ -52,6 +52,7 @@ class Globals(Base): "SleepTimeAfterReboot": "sleepTimeAfterReboot", "TitlePageComments": "titlePageComments", "UseDefaultRootPath": "useDefaultRootPath", + "UserName": "userName", "Version": "version", } _SDM_ENUM_MAP = {} @@ -314,6 +315,21 @@ def UseDefaultRootPath(self, value): # type: (bool) -> None self._set_attribute(self._SDM_ATT_MAP["UseDefaultRootPath"], value) + @property + def UserName(self): + # type: () -> str + """ + Returns + ------- + - str: User-specified version for reporting + """ + return self._get_attribute(self._SDM_ATT_MAP["UserName"]) + + @UserName.setter + def UserName(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["UserName"], value) + @property def Version(self): # type: () -> str @@ -348,9 +364,10 @@ def update( SleepTimeAfterReboot=None, TitlePageComments=None, UseDefaultRootPath=None, + UserName=None, Version=None, ): - # type: (str, bool, bool, bool, bool, bool, bool, bool, int, int, str, str, bool, str, int, str, bool, str) -> Globals + # type: (str, bool, bool, bool, bool, bool, bool, bool, int, int, str, str, bool, str, int, str, bool, str, str) -> Globals """Updates globals resource on the server. Args @@ -372,6 +389,7 @@ def update( - SleepTimeAfterReboot (number): If a reboot is initiated, the sleep after reboot is the number of seconds to wait after the port CPU goes into sleep mode. - TitlePageComments (str): User-specified comments for title page - UseDefaultRootPath (bool): This object uses the default root path for quick test. + - UserName (str): User-specified version for reporting - Version (str): User-specified version for reporting Raises @@ -399,9 +417,10 @@ def find( SleepTimeAfterReboot=None, TitlePageComments=None, UseDefaultRootPath=None, + UserName=None, Version=None, ): - # type: (str, bool, bool, bool, bool, bool, bool, bool, int, int, str, str, bool, str, int, str, bool, str) -> Globals + # type: (str, bool, bool, bool, bool, bool, bool, bool, int, int, str, str, bool, str, int, str, bool, str, str) -> Globals """Finds and retrieves globals resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve globals resources from the server. @@ -427,6 +446,7 @@ def find( - SleepTimeAfterReboot (number): If a reboot is initiated, the sleep after reboot is the number of seconds to wait after the port CPU goes into sleep mode. - TitlePageComments (str): User-specified comments for title page - UseDefaultRootPath (bool): This object uses the default root path for quick test. + - UserName (str): User-specified version for reporting - Version (str): User-specified version for reporting Returns diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/quicktest.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/quicktest.py index 711fe9f71..8341026fd 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/quicktest.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/quicktest.py @@ -369,13 +369,13 @@ def Globals(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.globals_605c8d39970b93a1aba6b6a97467871c.Globals): An instance of the Globals class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.globals_69a5d2805874fa9bd7dc448d50ded673.Globals): An instance of the Globals class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.globals_605c8d39970b93a1aba6b6a97467871c import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.globals_69a5d2805874fa9bd7dc448d50ded673 import ( Globals, ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/rfc2544frameloss_868b9746dda2d0cfeed81516cf37d39d.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/rfc2544frameloss_868b9746dda2d0cfeed81516cf37d39d.py index 1e4191656..b72e0eb60 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/rfc2544frameloss_868b9746dda2d0cfeed81516cf37d39d.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/rfc2544frameloss_868b9746dda2d0cfeed81516cf37d39d.py @@ -114,13 +114,13 @@ def TestConfig(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.testconfig_c489e9ff2fb488d788b6fa3b1a4398da.TestConfig): An instance of the TestConfig class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.testconfig_78347fb65f11863985b6ff94967b79ea.TestConfig): An instance of the TestConfig class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.testconfig_c489e9ff2fb488d788b6fa3b1a4398da import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.testconfig_78347fb65f11863985b6ff94967b79ea import ( TestConfig, ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/rfc2544throughput_86fc74b3228f97518d2513e6b33a3960.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/rfc2544throughput_86fc74b3228f97518d2513e6b33a3960.py index 36cab6fb2..557d496c8 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/rfc2544throughput_86fc74b3228f97518d2513e6b33a3960.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/rfc2544throughput_86fc74b3228f97518d2513e6b33a3960.py @@ -114,13 +114,13 @@ def TestConfig(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.testconfig_7a5f32980f4b9c35eca7634687724e2f.TestConfig): An instance of the TestConfig class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.testconfig_7ca2c82735006c164901bba6588dc318.TestConfig): An instance of the TestConfig class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.testconfig_7a5f32980f4b9c35eca7634687724e2f import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.testconfig_7ca2c82735006c164901bba6588dc318 import ( TestConfig, ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/rfc3918groupcapacity_283c76beeb0bd3309d21f95efa64cf3e.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/rfc3918groupcapacity_283c76beeb0bd3309d21f95efa64cf3e.py index 42098a144..d468d6db0 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/rfc3918groupcapacity_283c76beeb0bd3309d21f95efa64cf3e.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/rfc3918groupcapacity_283c76beeb0bd3309d21f95efa64cf3e.py @@ -114,13 +114,13 @@ def TestConfig(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.testconfig_5889cc38d331ea876ad698ef4dcc8344.TestConfig): An instance of the TestConfig class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.testconfig_6ecc050475b14b80814d357227c4f1bf.TestConfig): An instance of the TestConfig class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.testconfig_5889cc38d331ea876ad698ef4dcc8344 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.quicktest.testconfig_6ecc050475b14b80814d357227c4f1bf import ( TestConfig, ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_5889cc38d331ea876ad698ef4dcc8344.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_6ecc050475b14b80814d357227c4f1bf.py similarity index 98% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_5889cc38d331ea876ad698ef4dcc8344.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_6ecc050475b14b80814d357227c4f1bf.py index 68a65e249..f72122515 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_5889cc38d331ea876ad698ef4dcc8344.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_6ecc050475b14b80814d357227c4f1bf.py @@ -58,6 +58,7 @@ class TestConfig(Base): "Gap": "gap", "GroupCapacityGreaterThan": "groupCapacityGreaterThan", "GroupDistributionType": "groupDistributionType", + "IgmpMaximumWaitTime": "igmpMaximumWaitTime", "IgmpV1Timeout": "igmpV1Timeout", "IgmpVersion": "igmpVersion", "Igmpv3MessageType": "igmpv3MessageType", @@ -466,6 +467,21 @@ def GroupDistributionType(self, value): # type: (str) -> None self._set_attribute(self._SDM_ATT_MAP["GroupDistributionType"], value) + @property + def IgmpMaximumWaitTime(self): + # type: () -> int + """ + Returns + ------- + - number: + """ + return self._get_attribute(self._SDM_ATT_MAP["IgmpMaximumWaitTime"]) + + @IgmpMaximumWaitTime.setter + def IgmpMaximumWaitTime(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["IgmpMaximumWaitTime"], value) + @property def IgmpV1Timeout(self): # type: () -> int @@ -1061,6 +1077,7 @@ def update( Gap=None, GroupCapacityGreaterThan=None, GroupDistributionType=None, + IgmpMaximumWaitTime=None, IgmpV1Timeout=None, IgmpVersion=None, Igmpv3MessageType=None, @@ -1100,7 +1117,7 @@ def update( TestTrafficType=None, TxDelay=None, ): - # type: (str, str, bool, int, int, int, int, str, int, bool, bool, bool, bool, bool, bool, bool, str, bool, str, List[str], int, int, str, int, int, str, str, int, str, int, str, str, str, str, int, int, int, int, str, str, int, int, int, int, int, int, int, str, int, int, bool, str, int, List[str], str, bool, bool, int, str, str, int) -> TestConfig + # type: (str, str, bool, int, int, int, int, str, int, bool, bool, bool, bool, bool, bool, bool, str, bool, str, List[str], int, int, str, int, int, int, str, str, int, str, int, str, str, str, str, int, int, int, int, str, str, int, int, int, int, int, int, int, str, int, int, bool, str, int, List[str], str, bool, bool, int, str, str, int) -> TestConfig """Updates testConfig resource on the server. Args @@ -1128,6 +1145,7 @@ def update( - Gap (number): The gap in transmission of frames. - GroupCapacityGreaterThan (number): Indicates the value by which the group capacity is greater than. - GroupDistributionType (str(acrossHosts | acrossPorts)): Indicates the group distribution type. + - IgmpMaximumWaitTime (number): - IgmpV1Timeout (number): It signifies the timeout of version 1 of IGMP. - IgmpVersion (number): The igmp version. - Igmpv3MessageType (str(exclude | include)): It gives details about the igmpv3 message type in the test configuration @@ -1198,6 +1216,7 @@ def find( Gap=None, GroupCapacityGreaterThan=None, GroupDistributionType=None, + IgmpMaximumWaitTime=None, IgmpV1Timeout=None, IgmpVersion=None, Igmpv3MessageType=None, @@ -1237,7 +1256,7 @@ def find( TestTrafficType=None, TxDelay=None, ): - # type: (str, str, bool, int, int, int, int, str, int, bool, bool, bool, bool, bool, bool, bool, str, bool, str, List[str], int, int, str, int, int, str, str, int, str, int, str, str, str, str, int, int, int, int, str, str, int, int, int, int, int, int, int, str, int, int, bool, str, int, List[str], str, bool, bool, int, str, str, int) -> TestConfig + # type: (str, str, bool, int, int, int, int, str, int, bool, bool, bool, bool, bool, bool, bool, str, bool, str, List[str], int, int, str, int, int, int, str, str, int, str, int, str, str, str, str, int, int, int, int, str, str, int, int, int, int, int, int, int, str, int, int, bool, str, int, List[str], str, bool, bool, int, str, str, int) -> TestConfig """Finds and retrieves testConfig resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve testConfig resources from the server. @@ -1269,6 +1288,7 @@ def find( - Gap (number): The gap in transmission of frames. - GroupCapacityGreaterThan (number): Indicates the value by which the group capacity is greater than. - GroupDistributionType (str(acrossHosts | acrossPorts)): Indicates the group distribution type. + - IgmpMaximumWaitTime (number): - IgmpV1Timeout (number): It signifies the timeout of version 1 of IGMP. - IgmpVersion (number): The igmp version. - Igmpv3MessageType (str(exclude | include)): It gives details about the igmpv3 message type in the test configuration diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_c489e9ff2fb488d788b6fa3b1a4398da.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_78347fb65f11863985b6ff94967b79ea.py similarity index 98% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_c489e9ff2fb488d788b6fa3b1a4398da.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_78347fb65f11863985b6ff94967b79ea.py index 9258aa61e..3223df380 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_c489e9ff2fb488d788b6fa3b1a4398da.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_78347fb65f11863985b6ff94967b79ea.py @@ -50,6 +50,7 @@ class TestConfig(Base): "EnableLayer1Rate": "enableLayer1Rate", "EnableMinFrameSize": "enableMinFrameSize", "EnableOldStatsForReef": "enableOldStatsForReef", + "EnableTxRealRate": "enableTxRealRate", "FloodedFramesEnabled": "floodedFramesEnabled", "ForceRegenerate": "forceRegenerate", "FrameSizeMode": "frameSizeMode", @@ -118,6 +119,7 @@ class TestConfig(Base): "Rfc2544ImixDataQoS": "rfc2544ImixDataQoS", "Rfc2889ordering": "rfc2889ordering", "Runmode": "runmode", + "ScaleTxRealRate": "scaleTxRealRate", "SendFullyMeshed": "sendFullyMeshed", "ShowDetailedBinaryResults": "showDetailedBinaryResults", "SpyderFramesizeList": "spyderFramesizeList", @@ -133,6 +135,7 @@ class TestConfig(Base): "StepTolerance": "stepTolerance", "SupportedTrafficTypes": "supportedTrafficTypes", "Tolerance": "tolerance", + "ToleranceTxRealRate": "toleranceTxRealRate", "TrafficType": "trafficType", "TxDelay": "txDelay", "UnchangedValueList": "unchangedValueList", @@ -211,6 +214,7 @@ class TestConfig(Base): "val2889Ordering", ], "runmode": ["duration", "noframes"], + "scaleTxRealRate": ["%"], "stepLoadUnit": [ "bpsRate", "fpsRate", @@ -453,6 +457,21 @@ def EnableOldStatsForReef(self, value): # type: (bool) -> None self._set_attribute(self._SDM_ATT_MAP["EnableOldStatsForReef"], value) + @property + def EnableTxRealRate(self): + # type: () -> bool + """ + Returns + ------- + - bool: + """ + return self._get_attribute(self._SDM_ATT_MAP["EnableTxRealRate"]) + + @EnableTxRealRate.setter + def EnableTxRealRate(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["EnableTxRealRate"], value) + @property def FloodedFramesEnabled(self): # type: () -> bool @@ -1477,6 +1496,21 @@ def Runmode(self, value): # type: (str) -> None self._set_attribute(self._SDM_ATT_MAP["Runmode"], value) + @property + def ScaleTxRealRate(self): + # type: () -> str + """ + Returns + ------- + - str(%): + """ + return self._get_attribute(self._SDM_ATT_MAP["ScaleTxRealRate"]) + + @ScaleTxRealRate.setter + def ScaleTxRealRate(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["ScaleTxRealRate"], value) + @property def SendFullyMeshed(self): # type: () -> bool @@ -1700,6 +1734,21 @@ def Tolerance(self, value): # type: (int) -> None self._set_attribute(self._SDM_ATT_MAP["Tolerance"], value) + @property + def ToleranceTxRealRate(self): + # type: () -> int + """ + Returns + ------- + - number: + """ + return self._get_attribute(self._SDM_ATT_MAP["ToleranceTxRealRate"]) + + @ToleranceTxRealRate.setter + def ToleranceTxRealRate(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["ToleranceTxRealRate"], value) + @property def TrafficType(self): # type: () -> str @@ -1777,6 +1826,7 @@ def update( EnableLayer1Rate=None, EnableMinFrameSize=None, EnableOldStatsForReef=None, + EnableTxRealRate=None, FloodedFramesEnabled=None, ForceRegenerate=None, FrameSizeMode=None, @@ -1845,6 +1895,7 @@ def update( Rfc2544ImixDataQoS=None, Rfc2889ordering=None, Runmode=None, + ScaleTxRealRate=None, SendFullyMeshed=None, ShowDetailedBinaryResults=None, SpyderFramesizeList=None, @@ -1860,6 +1911,7 @@ def update( StepTolerance=None, SupportedTrafficTypes=None, Tolerance=None, + ToleranceTxRealRate=None, TrafficType=None, TxDelay=None, UnchangedValueList=None, @@ -1884,6 +1936,7 @@ def update( - EnableLayer1Rate (bool): NOT DEFINED - EnableMinFrameSize (bool): If true, enables minimum frame size. - EnableOldStatsForReef (bool): If true, enables old statistics for reef load module. + - EnableTxRealRate (bool): - FloodedFramesEnabled (bool): If true, it enables the flooded frames statistics - ForceRegenerate (bool): Initiates a forced regeneration. - FrameSizeMode (str(custom | customlist | increment | random | unchanged)): This attribute is the frame size mode for the Quad Gaussian. @@ -1952,6 +2005,7 @@ def update( - Rfc2544ImixDataQoS (bool): If true, it uses the same frame data qos - Rfc2889ordering (str(noOrdering | peakLoading | unchanged | val2889Ordering)): If true, indicates frame ordering by Rfc2889. - Runmode (str(duration | noframes)): Specifies the number of frames that IxNetwork sends from each port in running mode. + - ScaleTxRealRate (str(%)): - SendFullyMeshed (bool): Indicates the source group mapping type used for sending data. - ShowDetailedBinaryResults (bool): - SpyderFramesizeList (list(dict(arg1:number,arg2:str[None | /api/v1/sessions/1/ixnetwork/quickTest/globals/customImix | /api/v1/sessions/1/ixnetwork/quickTest/globals/imix]))): @@ -1967,6 +2021,7 @@ def update( - StepTolerance (number): The step value of the tolerance level. - SupportedTrafficTypes (str): The traffic types supported. - Tolerance (number): The value set for the tolerance level. + - ToleranceTxRealRate (number): - TrafficType (str(burstyLoading | constantLoading)): The test based on the traffic type. - TxDelay (number): Specifies the amount of delay after every transmit. - UnchangedValueList (str): The number of unchanged sessions. @@ -1995,6 +2050,7 @@ def find( EnableLayer1Rate=None, EnableMinFrameSize=None, EnableOldStatsForReef=None, + EnableTxRealRate=None, FloodedFramesEnabled=None, ForceRegenerate=None, FrameSizeMode=None, @@ -2063,6 +2119,7 @@ def find( Rfc2544ImixDataQoS=None, Rfc2889ordering=None, Runmode=None, + ScaleTxRealRate=None, SendFullyMeshed=None, ShowDetailedBinaryResults=None, SpyderFramesizeList=None, @@ -2078,6 +2135,7 @@ def find( StepTolerance=None, SupportedTrafficTypes=None, Tolerance=None, + ToleranceTxRealRate=None, TrafficType=None, TxDelay=None, UnchangedValueList=None, @@ -2106,6 +2164,7 @@ def find( - EnableLayer1Rate (bool): NOT DEFINED - EnableMinFrameSize (bool): If true, enables minimum frame size. - EnableOldStatsForReef (bool): If true, enables old statistics for reef load module. + - EnableTxRealRate (bool): - FloodedFramesEnabled (bool): If true, it enables the flooded frames statistics - ForceRegenerate (bool): Initiates a forced regeneration. - FrameSizeMode (str(custom | customlist | increment | random | unchanged)): This attribute is the frame size mode for the Quad Gaussian. @@ -2174,6 +2233,7 @@ def find( - Rfc2544ImixDataQoS (bool): If true, it uses the same frame data qos - Rfc2889ordering (str(noOrdering | peakLoading | unchanged | val2889Ordering)): If true, indicates frame ordering by Rfc2889. - Runmode (str(duration | noframes)): Specifies the number of frames that IxNetwork sends from each port in running mode. + - ScaleTxRealRate (str(%)): - SendFullyMeshed (bool): Indicates the source group mapping type used for sending data. - ShowDetailedBinaryResults (bool): - SpyderFramesizeList (list(dict(arg1:number,arg2:str[None | /api/v1/sessions/1/ixnetwork/quickTest/globals/customImix | /api/v1/sessions/1/ixnetwork/quickTest/globals/imix]))): @@ -2189,6 +2249,7 @@ def find( - StepTolerance (number): The step value of the tolerance level. - SupportedTrafficTypes (str): The traffic types supported. - Tolerance (number): The value set for the tolerance level. + - ToleranceTxRealRate (number): - TrafficType (str(burstyLoading | constantLoading)): The test based on the traffic type. - TxDelay (number): Specifies the amount of delay after every transmit. - UnchangedValueList (str): The number of unchanged sessions. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_7a5f32980f4b9c35eca7634687724e2f.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_7ca2c82735006c164901bba6588dc318.py similarity index 99% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_7a5f32980f4b9c35eca7634687724e2f.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_7ca2c82735006c164901bba6588dc318.py index 02545fa4a..190cd6c67 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_7a5f32980f4b9c35eca7634687724e2f.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/quicktest/testconfig_7ca2c82735006c164901bba6588dc318.py @@ -144,6 +144,7 @@ class TestConfig(Base): "EnableOldStatsForReef": "enableOldStatsForReef", "EnableSaturationIteration": "enableSaturationIteration", "EnableStopTestOnHighLoss": "enableStopTestOnHighLoss", + "EnableTxRealRate": "enableTxRealRate", "ExtraIterationOffsets": "extraIterationOffsets", "ExtraRetriesOnLoss": "extraRetriesOnLoss", "FastConvergenceDuration": "fastConvergenceDuration", @@ -243,6 +244,7 @@ class TestConfig(Base): "Rfc2544ImixDataQoS": "rfc2544ImixDataQoS", "Rfc2889ordering": "rfc2889ordering", "SaturationIteration": "saturationIteration", + "ScaleTxRealRate": "scaleTxRealRate", "SearchBase": "searchBase", "SendFullyMeshed": "sendFullyMeshed", "ShowDetailedBinaryResults": "showDetailedBinaryResults", @@ -319,6 +321,7 @@ class TestConfig(Base): "StopTestOnHighLoss": "stopTestOnHighLoss", "SupportedTrafficTypes": "supportedTrafficTypes", "Tolerance": "tolerance", + "ToleranceTxRealRate": "toleranceTxRealRate", "TrafficType": "trafficType", "TxDelay": "txDelay", "UnchangedInitial": "unchangedInitial", @@ -495,6 +498,7 @@ class TestConfig(Base): "unchanged", "val2889Ordering", ], + "scaleTxRealRate": ["%"], "searchBase": ["rate", "replicationCount"], "stepFrameLossUnit": ["%", "frames"], "stepLoadUnit": [ @@ -2264,6 +2268,21 @@ def EnableStopTestOnHighLoss(self, value): # type: (bool) -> None self._set_attribute(self._SDM_ATT_MAP["EnableStopTestOnHighLoss"], value) + @property + def EnableTxRealRate(self): + # type: () -> bool + """ + Returns + ------- + - bool: + """ + return self._get_attribute(self._SDM_ATT_MAP["EnableTxRealRate"]) + + @EnableTxRealRate.setter + def EnableTxRealRate(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["EnableTxRealRate"], value) + @property def ExtraIterationOffsets(self): # type: () -> str @@ -3753,6 +3772,21 @@ def SaturationIteration(self, value): # type: (int) -> None self._set_attribute(self._SDM_ATT_MAP["SaturationIteration"], value) + @property + def ScaleTxRealRate(self): + # type: () -> str + """ + Returns + ------- + - str(%): + """ + return self._get_attribute(self._SDM_ATT_MAP["ScaleTxRealRate"]) + + @ScaleTxRealRate.setter + def ScaleTxRealRate(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["ScaleTxRealRate"], value) + @property def SearchBase(self): # type: () -> str @@ -4947,6 +4981,21 @@ def Tolerance(self, value): # type: (int) -> None self._set_attribute(self._SDM_ATT_MAP["Tolerance"], value) + @property + def ToleranceTxRealRate(self): + # type: () -> int + """ + Returns + ------- + - number: + """ + return self._get_attribute(self._SDM_ATT_MAP["ToleranceTxRealRate"]) + + @ToleranceTxRealRate.setter + def ToleranceTxRealRate(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["ToleranceTxRealRate"], value) + @property def TrafficType(self): # type: () -> str @@ -5151,6 +5200,7 @@ def update(self, **kwargs): - EnableOldStatsForReef (bool): If true, enables old statistics for reef load module. - EnableSaturationIteration (bool): If true, SaturationIteration in enabled . - EnableStopTestOnHighLoss (bool): The test stops in case of a high loss. + - EnableTxRealRate (bool): - ExtraIterationOffsets (str): This enables the test to run an extra iteration. - ExtraRetriesOnLoss (number): - FastConvergenceDuration (number): sec @@ -5250,6 +5300,7 @@ def update(self, **kwargs): - Rfc2544ImixDataQoS (bool): If true, it uses the same frame data qos - Rfc2889ordering (str(noOrdering | peakLoading | unchanged | val2889Ordering)): If true, indicates frame ordering by Rfc2889. - SaturationIteration (number): This enables the test to run an extra iteration for calculating the Saturation latency. + - ScaleTxRealRate (str(%)): - SearchBase (str(rate | replicationCount)): NOT DEFINED - SendFullyMeshed (bool): Indicates the source group mapping type used for sending data. - ShowDetailedBinaryResults (bool): NOT DEFINED @@ -5326,6 +5377,7 @@ def update(self, **kwargs): - StopTestOnHighLoss (number): It stops test on high loss. - SupportedTrafficTypes (str): The supported traffic types. - Tolerance (number): The tolerance value. + - ToleranceTxRealRate (number): - TrafficType (str(burstyLoading | constantLoading)): It signifies the traffic type for the protocol. Possible values include: - TxDelay (number): The minimum delay between successive packets. - UnchangedInitial (str(False | True)): The first value of an unchanged parameter. @@ -5457,6 +5509,7 @@ def find(self, **kwargs): - EnableOldStatsForReef (bool): If true, enables old statistics for reef load module. - EnableSaturationIteration (bool): If true, SaturationIteration in enabled . - EnableStopTestOnHighLoss (bool): The test stops in case of a high loss. + - EnableTxRealRate (bool): - ExtraIterationOffsets (str): This enables the test to run an extra iteration. - ExtraRetriesOnLoss (number): - FastConvergenceDuration (number): sec @@ -5556,6 +5609,7 @@ def find(self, **kwargs): - Rfc2544ImixDataQoS (bool): If true, it uses the same frame data qos - Rfc2889ordering (str(noOrdering | peakLoading | unchanged | val2889Ordering)): If true, indicates frame ordering by Rfc2889. - SaturationIteration (number): This enables the test to run an extra iteration for calculating the Saturation latency. + - ScaleTxRealRate (str(%)): - SearchBase (str(rate | replicationCount)): NOT DEFINED - SendFullyMeshed (bool): Indicates the source group mapping type used for sending data. - ShowDetailedBinaryResults (bool): NOT DEFINED @@ -5632,6 +5686,7 @@ def find(self, **kwargs): - StopTestOnHighLoss (number): It stops test on high loss. - SupportedTrafficTypes (str): The supported traffic types. - Tolerance (number): The tolerance value. + - ToleranceTxRealRate (number): - TrafficType (str(burstyLoading | constantLoading)): It signifies the traffic type for the protocol. Possible values include: - TxDelay (number): The minimum delay between successive packets. - UnchangedInitial (str(False | True)): The first value of an unchanged parameter. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/resourcemanager/resourcemanager.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/resourcemanager/resourcemanager.py index 4a50d02e7..4309d8a1c 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/resourcemanager/resourcemanager.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/resourcemanager/resourcemanager.py @@ -127,6 +127,30 @@ def ExportConfigFile(self, *args, **kwargs): payload[item[0]] = item[1] return self._execute("exportConfigFile", payload=payload, response_object=None) + def GetSdmTreeNodesForExport(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[str, None] + """Executes the getSdmTreeNodesForExport operation on the server. + + getSdmTreeNodesForExport(Arg2=string, async_operation=bool)string + ----------------------------------------------------------------- + - Arg2 (str): + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns str: + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self.href} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute( + "getSdmTreeNodesForExport", payload=payload, response_object=None + ) + def ImportConfig(self, *args, **kwargs): # type: (*Any, **Any) -> Union[List[str], None] """Executes the importConfig operation on the server. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/csvsnapshot/csvsnapshot.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/csvsnapshot/csvsnapshot.py index b6f86efe3..324488963 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/csvsnapshot/csvsnapshot.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/csvsnapshot/csvsnapshot.py @@ -242,7 +242,7 @@ def Views(self): """ Returns ------- - - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view]): NOT DEFINED + - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view]): The root node for all statistics view. """ return self._get_attribute(self._SDM_ATT_MAP["Views"]) @@ -282,7 +282,7 @@ def update( - OpenViewer (bool): - SnapshotViewContents (str(allPages | currentPage)): NOT DEFINED - SnapshotViewCsvGenerationMode (str(appendCSVFile | newCSVFile | overwriteCSVFile)): NOT DEFINED - - Views (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view])): NOT DEFINED + - Views (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view])): The root node for all statistics view. Raises ------ @@ -327,7 +327,7 @@ def find( - SnapshotSettingsName (str): NOT DEFINED - SnapshotViewContents (str(allPages | currentPage)): NOT DEFINED - SnapshotViewCsvGenerationMode (str(appendCSVFile | newCSVFile | overwriteCSVFile)): NOT DEFINED - - Views (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view])): NOT DEFINED + - Views (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view])): The root node for all statistics view. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/rawdata/statistic/statistic.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/rawdata/statistic/statistic.py index 284aff1f7..2d28ac8d1 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/rawdata/statistic/statistic.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/rawdata/statistic/statistic.py @@ -28,7 +28,7 @@ class Statistic(Base): - """ + """Raw data statistics parameters. The Statistic class encapsulates a list of statistic resources that are managed by the system. A list of resources can be retrieved from the server using the Statistic.find() method. """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/advancedcvfilters/advancedcvfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/advancedcvfilters/advancedcvfilters.py index d6a563e43..2ad479a76 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/advancedcvfilters/advancedcvfilters.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/advancedcvfilters/advancedcvfilters.py @@ -136,7 +136,7 @@ def SortingStats(self): """ Returns ------- - - str: Specifies the list of statistics by which the view is sorted. + - str: Returns the list of statistics by which the view will be sorted. """ return self._get_attribute(self._SDM_ATT_MAP["SortingStats"]) @@ -162,7 +162,7 @@ def update( - Expression (str): Specifies the filter body. This is a string that must have the specific format. This can be empty or no filter.The available operations and statistics can be obtained from availableFilterOptions. - Grouping (str): Sets a grouping for the filter. - Protocol (str): Sets a protocol for the filter. - - SortingStats (str): Specifies the list of statistics by which the view is sorted. + - SortingStats (str): Returns the list of statistics by which the view will be sorted. Raises ------ @@ -187,7 +187,7 @@ def add( - Expression (str): Specifies the filter body. This is a string that must have the specific format. This can be empty or no filter.The available operations and statistics can be obtained from availableFilterOptions. - Grouping (str): Sets a grouping for the filter. - Protocol (str): Sets a protocol for the filter. - - SortingStats (str): Specifies the list of statistics by which the view is sorted. + - SortingStats (str): Returns the list of statistics by which the view will be sorted. Returns ------- @@ -234,7 +234,7 @@ def find( - Expression (str): Specifies the filter body. This is a string that must have the specific format. This can be empty or no filter.The available operations and statistics can be obtained from availableFilterOptions. - Grouping (str): Sets a grouping for the filter. - Protocol (str): Sets a protocol for the filter. - - SortingStats (str): Specifies the list of statistics by which the view is sorted. + - SortingStats (str): Returns the list of statistics by which the view will be sorted. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/availableprotocolfilter/availableprotocolfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/availableprotocolfilter/availableprotocolfilter.py index 2ccb2b017..6ba9beb89 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/availableprotocolfilter/availableprotocolfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/availableprotocolfilter/availableprotocolfilter.py @@ -49,7 +49,7 @@ def Name(self): """ Returns ------- - - str: The unique identifier of the object. + - str: The unique identifier of the protocol filter object. """ return self._get_attribute(self._SDM_ATT_MAP["Name"]) @@ -76,7 +76,7 @@ def find(self, Name=None): Args ---- - - Name (str): The unique identifier of the object. + - Name (str): The unique identifier of the protocol filter object. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/availablestatisticfilter/availablestatisticfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/availablestatisticfilter/availablestatisticfilter.py index 9bc9f540e..80cef1612 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/availablestatisticfilter/availablestatisticfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/availablestatisticfilter/availablestatisticfilter.py @@ -49,7 +49,7 @@ def Caption(self): """ Returns ------- - - str: Name of the statistic. + - str: The reference statistic by which the data will be sorted in created SV. """ return self._get_attribute(self._SDM_ATT_MAP["Caption"]) @@ -76,7 +76,7 @@ def find(self, Caption=None): Args ---- - - Caption (str): Name of the statistic. + - Caption (str): The reference statistic by which the data will be sorted in created SV. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/data/data.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/data/data.py index 5912e752c..ed54dd1e5 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/data/data.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/data/data.py @@ -107,7 +107,7 @@ def AllowPaging(self): """ Returns ------- - - bool: + - bool: If true, statistics will be displayed in multiple pages. """ return self._get_attribute(self._SDM_ATT_MAP["AllowPaging"]) @@ -117,7 +117,7 @@ def ColumnCaptions(self): """ Returns ------- - - list(str): + - list(str): The statistics column captions. """ return self._get_attribute(self._SDM_ATT_MAP["ColumnCaptions"]) @@ -127,7 +127,7 @@ def ColumnCount(self): """ Returns ------- - - number: + - number: Displays the particular column number in the view. """ return self._get_attribute(self._SDM_ATT_MAP["ColumnCount"]) @@ -137,7 +137,7 @@ def CurrentPage(self): """ Returns ------- - - number: + - number: The current page number being displayed. """ return self._get_attribute(self._SDM_ATT_MAP["CurrentPage"]) @@ -182,7 +182,7 @@ def EgressPageSize(self): """ Returns ------- - - number: + - number: The current egress page size across all ingress rows. Default = 3 """ return self._get_attribute(self._SDM_ATT_MAP["EgressPageSize"]) @@ -197,7 +197,7 @@ def IsBlocked(self): """ Returns ------- - - bool: + - bool: Is a flag used to fetch the status of view (returns true if the views was blocked by Guard Rail, false otherwise) """ return self._get_attribute(self._SDM_ATT_MAP["IsBlocked"]) @@ -207,7 +207,7 @@ def IsReady(self): """ Returns ------- - - bool: + - bool: If true, the counter is ready to record statistics. """ return self._get_attribute(self._SDM_ATT_MAP["IsReady"]) @@ -217,7 +217,7 @@ def LastPageSize(self): """ Returns ------- - - number: + - number: The number of statistics in the last page. """ return self._get_attribute(self._SDM_ATT_MAP["LastPageSize"]) @@ -227,7 +227,7 @@ def PageSize(self): """ Returns ------- - - number: + - number: The number of statistics per page. """ return self._get_attribute(self._SDM_ATT_MAP["PageSize"]) @@ -251,7 +251,7 @@ def RowCount(self): """ Returns ------- - - number: + - number: Displays the particular row number in the view. """ return self._get_attribute(self._SDM_ATT_MAP["RowCount"]) @@ -260,7 +260,7 @@ def RowValues(self): """DEPRECATED Returns ------- - - dict(arg1:list[list[list[str]]]): + - dict(arg1:list[list[list[str]]]): All statistics values in a row. """ return self._get_attribute(self._SDM_ATT_MAP["RowValues"]) @@ -270,7 +270,7 @@ def Timestamp(self): """ Returns ------- - - number: + - number: Describes the date and time of the event. """ return self._get_attribute(self._SDM_ATT_MAP["Timestamp"]) @@ -280,7 +280,7 @@ def TotalPages(self): """ Returns ------- - - number: + - number: The total number of statistics pages. """ return self._get_attribute(self._SDM_ATT_MAP["TotalPages"]) @@ -290,7 +290,7 @@ def TotalRows(self): """ Returns ------- - - number: + - number: Total number of statistic rows. """ return self._get_attribute(self._SDM_ATT_MAP["TotalRows"]) @@ -307,11 +307,11 @@ def update( Args ---- - - CurrentPage (number): + - CurrentPage (number): The current page number being displayed. - EgressMode (str(conditional | paged)): - EgressOption (str(rowsWithNoPackets | rowsWithPackets | showAll)): - - EgressPageSize (number): - - PageSize (number): + - EgressPageSize (number): The current egress page size across all ingress rows. Default = 3 + - PageSize (number): The number of statistics per page. Raises ------ @@ -347,23 +347,23 @@ def find( Args ---- - - AllowPaging (bool): - - ColumnCaptions (list(str)): - - ColumnCount (number): - - CurrentPage (number): + - AllowPaging (bool): If true, statistics will be displayed in multiple pages. + - ColumnCaptions (list(str)): The statistics column captions. + - ColumnCount (number): Displays the particular column number in the view. + - CurrentPage (number): The current page number being displayed. - EgressMode (str(conditional | paged)): - EgressOption (str(rowsWithNoPackets | rowsWithPackets | showAll)): - - EgressPageSize (number): - - IsBlocked (bool): - - IsReady (bool): - - LastPageSize (number): - - PageSize (number): + - EgressPageSize (number): The current egress page size across all ingress rows. Default = 3 + - IsBlocked (bool): Is a flag used to fetch the status of view (returns true if the views was blocked by Guard Rail, false otherwise) + - IsReady (bool): If true, the counter is ready to record statistics. + - LastPageSize (number): The number of statistics in the last page. + - PageSize (number): The number of statistics per page. - PageValues (list(list[list[str]])): Returns the values in the current page. The ingress row is grouped with its corresponding egress rows - - RowCount (number): - - RowValues (dict(arg1:list[list[list[str]]])): - - Timestamp (number): - - TotalPages (number): - - TotalRows (number): + - RowCount (number): Displays the particular row number in the view. + - RowValues (dict(arg1:list[list[list[str]]])): All statistics values in a row. + - Timestamp (number): Describes the date and time of the event. + - TotalPages (number): The total number of statistics pages. + - TotalRows (number): Total number of statistic rows. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/data/egress/egress.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/data/egress/egress.py index 70eabd61a..899dfaea7 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/data/egress/egress.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/data/egress/egress.py @@ -72,7 +72,7 @@ def CommitEgressPage(self): """ Returns ------- - - bool: + - bool: Attribute used to commit egress paging from script. """ return self._get_attribute(self._SDM_ATT_MAP["CommitEgressPage"]) @@ -87,7 +87,7 @@ def CurrentPage(self): """ Returns ------- - - number: + - number: The current page number being displayed. """ return self._get_attribute(self._SDM_ATT_MAP["CurrentPage"]) @@ -102,7 +102,7 @@ def RowCount(self): """ Returns ------- - - number: + - number: Displays the particular row number in the view. """ return self._get_attribute(self._SDM_ATT_MAP["RowCount"]) @@ -112,7 +112,7 @@ def TotalPages(self): """ Returns ------- - - number: + - number: The total number of statistics pages. """ return self._get_attribute(self._SDM_ATT_MAP["TotalPages"]) @@ -122,8 +122,8 @@ def update(self, CommitEgressPage=None, CurrentPage=None): Args ---- - - CommitEgressPage (bool): - - CurrentPage (number): + - CommitEgressPage (bool): Attribute used to commit egress paging from script. + - CurrentPage (number): The current page number being displayed. Raises ------ @@ -137,8 +137,8 @@ def add(self, CommitEgressPage=None, CurrentPage=None): Args ---- - - CommitEgressPage (bool): - - CurrentPage (number): + - CommitEgressPage (bool): Attribute used to commit egress paging from script. + - CurrentPage (number): The current page number being displayed. Returns ------- @@ -162,10 +162,10 @@ def find( Args ---- - - CommitEgressPage (bool): - - CurrentPage (number): - - RowCount (number): - - TotalPages (number): + - CommitEgressPage (bool): Attribute used to commit egress paging from script. + - CurrentPage (number): The current page number being displayed. + - RowCount (number): Displays the particular row number in the view. + - TotalPages (number): The total number of statistics pages. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/data/egress/flowcondition/flowcondition.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/data/egress/flowcondition/flowcondition.py index dd535d9b7..1a19ec337 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/data/egress/flowcondition/flowcondition.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/data/egress/flowcondition/flowcondition.py @@ -78,7 +78,7 @@ def ShowFirstMatchingSet(self): """ Returns ------- - - bool: + - bool: If true, displays the first matching set. """ return self._get_attribute(self._SDM_ATT_MAP["ShowFirstMatchingSet"]) @@ -93,7 +93,7 @@ def TrackingFilterId(self): """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter): + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter): Selected tracking filters from the availableTrackingFilter list. """ return self._get_attribute(self._SDM_ATT_MAP["TrackingFilterId"]) @@ -108,7 +108,7 @@ def Values(self): """ Returns ------- - - list(number): + - list(number): Value to be matched for the condition. """ return self._get_attribute(self._SDM_ATT_MAP["Values"]) @@ -130,9 +130,9 @@ def update( Args ---- - Operator (str(isBetween | isDifferent | isEqual | isEqualOrGreater | isEqualOrSmaller | isGreater | isSmaller)): - - ShowFirstMatchingSet (bool): - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter)): - - Values (list(number)): + - ShowFirstMatchingSet (bool): If true, displays the first matching set. + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. + - Values (list(number)): Value to be matched for the condition. Raises ------ @@ -153,9 +153,9 @@ def add( Args ---- - Operator (str(isBetween | isDifferent | isEqual | isEqualOrGreater | isEqualOrSmaller | isGreater | isSmaller)): - - ShowFirstMatchingSet (bool): - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter)): - - Values (list(number)): + - ShowFirstMatchingSet (bool): If true, displays the first matching set. + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. + - Values (list(number)): Value to be matched for the condition. Returns ------- @@ -194,9 +194,9 @@ def find( Args ---- - Operator (str(isBetween | isDifferent | isEqual | isEqualOrGreater | isEqualOrSmaller | isGreater | isSmaller)): - - ShowFirstMatchingSet (bool): - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter)): - - Values (list(number)): + - ShowFirstMatchingSet (bool): If true, displays the first matching set. + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. + - Values (list(number)): Value to be matched for the condition. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/innerglobalstats/innerglobalstats.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/innerglobalstats/innerglobalstats.py index 5b0a482ea..5ba79d8f8 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/innerglobalstats/innerglobalstats.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/innerglobalstats/innerglobalstats.py @@ -49,7 +49,7 @@ def ColumnCaptions(self): """ Returns ------- - - list(str): NOT DEFINED + - list(str): The statistics column caption. """ return self._get_attribute(self._SDM_ATT_MAP["ColumnCaptions"]) @@ -59,7 +59,7 @@ def RowValues(self): """ Returns ------- - - list(str): NOT DEFINED + - list(str): All statistics values in a row. """ return self._get_attribute(self._SDM_ATT_MAP["RowValues"]) @@ -73,8 +73,8 @@ def find(self, ColumnCaptions=None, RowValues=None): Args ---- - - ColumnCaptions (list(str)): NOT DEFINED - - RowValues (list(str)): NOT DEFINED + - ColumnCaptions (list(str)): The statistics column caption. + - RowValues (list(str)): All statistics values in a row. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/advancedfilter/advancedfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/advancedfilter/advancedfilter.py index 3328a1b12..d04e53d41 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/advancedfilter/advancedfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/advancedfilter/advancedfilter.py @@ -68,7 +68,7 @@ def Name(self): """ Returns ------- - - str: Specifies the filter name. It must be unique per view. + - str: Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. """ return self._get_attribute(self._SDM_ATT_MAP["Name"]) @@ -83,7 +83,7 @@ def SortingStats(self): """ Returns ------- - - str: Specifies the list of statistics by which the view will be sorted. + - str: Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. """ return self._get_attribute(self._SDM_ATT_MAP["SortingStats"]) @@ -98,7 +98,7 @@ def TrackingFilterId(self): """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters): Gets the id of the filter, which is used to add the filter to a view. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters): Gets the id of the filter, which is used to add the filter to a view. """ return self._get_attribute(self._SDM_ATT_MAP["TrackingFilterId"]) @@ -116,9 +116,9 @@ def update( Args ---- - Expression (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. - - Name (str): Specifies the filter name. It must be unique per view. - - SortingStats (str): Specifies the list of statistics by which the view will be sorted. - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters)): Gets the id of the filter, which is used to add the filter to a view. + - Name (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. + - SortingStats (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters)): Gets the id of the filter, which is used to add the filter to a view. Raises ------ @@ -133,9 +133,9 @@ def add(self, Expression=None, Name=None, SortingStats=None, TrackingFilterId=No Args ---- - Expression (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. - - Name (str): Specifies the filter name. It must be unique per view. - - SortingStats (str): Specifies the list of statistics by which the view will be sorted. - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters)): Gets the id of the filter, which is used to add the filter to a view. + - Name (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. + - SortingStats (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters)): Gets the id of the filter, which is used to add the filter to a view. Returns ------- @@ -170,9 +170,9 @@ def find( Args ---- - Expression (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. - - Name (str): Specifies the filter name. It must be unique per view. - - SortingStats (str): Specifies the list of statistics by which the view will be sorted. - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters)): Gets the id of the filter, which is used to add the filter to a view. + - Name (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. + - SortingStats (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters)): Gets the id of the filter, which is used to add the filter to a view. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/layer23nextgenprotocolfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/layer23nextgenprotocolfilter.py index db0d95470..734c7e079 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/layer23nextgenprotocolfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/layer23nextgenprotocolfilter.py @@ -92,13 +92,53 @@ def AvailableAdvancedFilterOptions(self): return self._properties.get("AvailableAdvancedFilterOptions") return AvailableAdvancedFilterOptions(self) + @property + def PortFilters(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23nextgenprotocolfilter.portfilters.portfilters.PortFilters): An instance of the PortFilters class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23nextgenprotocolfilter.portfilters.portfilters import ( + PortFilters, + ) + + if len(self._object_properties) > 0: + if self._properties.get("PortFilters", None) is not None: + return self._properties.get("PortFilters") + return PortFilters(self) + + @property + def ProtocolFilters(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23nextgenprotocolfilter.protocolfilters.protocolfilters.ProtocolFilters): An instance of the ProtocolFilters class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23nextgenprotocolfilter.protocolfilters.protocolfilters import ( + ProtocolFilters, + ) + + if len(self._object_properties) > 0: + if self._properties.get("ProtocolFilters", None) is not None: + return self._properties.get("ProtocolFilters") + return ProtocolFilters(self) + @property def AdvancedCVFilter(self): # type: () -> str """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/advancedCVFilters): Sets the advanced filter for a custom view. Note: To change the filter on an existing view, you must first disable it. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../advancedCVFilters): Sets the advanced filter for a custom view. Note- To change the filter on an existing view, you must first disable it. """ return self._get_attribute(self._SDM_ATT_MAP["AdvancedCVFilter"]) @@ -143,7 +183,7 @@ def AllAdvancedFilters(self): """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters): Returns a list with all the filters that are present in the selected drill down views. This includes filters that cannot be applied for the current drill down view. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters): Returns a list with all the filters that are present in the selected drill down views. This includes filters that cannot be applied for the current drill down view. """ return self._get_attribute(self._SDM_ATT_MAP["AllAdvancedFilters"]) @@ -153,7 +193,7 @@ def MatchingAdvancedFilters(self): """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters): Returns a list that contains only the filters that can be applied on the current drill down view. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters): Returns a list that contains only the filters that can be applied on the current drill down view. """ return self._get_attribute(self._SDM_ATT_MAP["MatchingAdvancedFilters"]) @@ -163,7 +203,7 @@ def PortFilterIds(self): """ Returns ------- - - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter]): Filters the port IDs + - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter]): Ports that have been filtered. """ return self._get_attribute(self._SDM_ATT_MAP["PortFilterIds"]) @@ -178,7 +218,7 @@ def ProtocolFilterIds(self): """ Returns ------- - - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolFilter]): Filters the protocol IDs + - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolFilter]): Protocols that have been filtered. """ return self._get_attribute(self._SDM_ATT_MAP["ProtocolFilterIds"]) @@ -200,11 +240,11 @@ def update( Args ---- - - AdvancedCVFilter (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/advancedCVFilters)): Sets the advanced filter for a custom view. Note: To change the filter on an existing view, you must first disable it. + - AdvancedCVFilter (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../advancedCVFilters)): Sets the advanced filter for a custom view. Note- To change the filter on an existing view, you must first disable it. - AdvancedFilterName (str): Selects an advanced filter from the ones available in the selected drill down view. - AggregationType (str(perPort | perSession)): Signifies the type of aggregation of next gen protocols - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Filters the port IDs - - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolFilter])): Filters the protocol IDs + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Ports that have been filtered. + - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolFilter])): Protocols that have been filtered. Raises ------ @@ -225,11 +265,11 @@ def add( Args ---- - - AdvancedCVFilter (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/advancedCVFilters)): Sets the advanced filter for a custom view. Note: To change the filter on an existing view, you must first disable it. + - AdvancedCVFilter (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../advancedCVFilters)): Sets the advanced filter for a custom view. Note- To change the filter on an existing view, you must first disable it. - AdvancedFilterName (str): Selects an advanced filter from the ones available in the selected drill down view. - AggregationType (str(perPort | perSession)): Signifies the type of aggregation of next gen protocols - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Filters the port IDs - - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolFilter])): Filters the protocol IDs + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Ports that have been filtered. + - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolFilter])): Protocols that have been filtered. Returns ------- @@ -270,13 +310,13 @@ def find( Args ---- - - AdvancedCVFilter (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/advancedCVFilters)): Sets the advanced filter for a custom view. Note: To change the filter on an existing view, you must first disable it. + - AdvancedCVFilter (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../advancedCVFilters)): Sets the advanced filter for a custom view. Note- To change the filter on an existing view, you must first disable it. - AdvancedFilterName (str): Selects an advanced filter from the ones available in the selected drill down view. - AggregationType (str(perPort | perSession)): Signifies the type of aggregation of next gen protocols - - AllAdvancedFilters (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters)): Returns a list with all the filters that are present in the selected drill down views. This includes filters that cannot be applied for the current drill down view. - - MatchingAdvancedFilters (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters)): Returns a list that contains only the filters that can be applied on the current drill down view. - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Filters the port IDs - - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolFilter])): Filters the protocol IDs + - AllAdvancedFilters (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters)): Returns a list with all the filters that are present in the selected drill down views. This includes filters that cannot be applied for the current drill down view. + - MatchingAdvancedFilters (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters)): Returns a list that contains only the filters that can be applied on the current drill down view. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Ports that have been filtered. + - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolFilter])): Protocols that have been filtered. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/portfilters/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/portfilters/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/portfilters/portfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/portfilters/portfilters.py new file mode 100644 index 000000000..2538e347b --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/portfilters/portfilters.py @@ -0,0 +1,143 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class PortFilters(Base): + """Contains list of all the ports available which can be enabled for the custom view. + The PortFilters class encapsulates a list of portFilters resources that are managed by the system. + A list of resources can be retrieved from the server using the PortFilters.find() method. + """ + + __slots__ = () + _SDM_NAME = "portFilters" + _SDM_ATT_MAP = { + "Enabled": "enabled", + "Name": "name", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(PortFilters, self).__init__(parent, list_op) + + @property + def Enabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: Value determining whether the filter is selected or not + """ + return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) + + @Enabled.setter + def Enabled(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Selected port filters from the Port Filter list. + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + def update(self, Enabled=None): + # type: (bool) -> PortFilters + """Updates portFilters resource on the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Enabled=None): + # type: (bool) -> PortFilters + """Adds a new portFilters resource on the json, only valid with batch add utility + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Returns + ------- + - self: This instance with all currently retrieved portFilters resources using find and the newly added portFilters resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Enabled=None, Name=None): + # type: (bool, str) -> PortFilters + """Finds and retrieves portFilters resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve portFilters resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all portFilters resources from the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - Name (str): Selected port filters from the Port Filter list. + + Returns + ------- + - self: This instance with matching portFilters resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of portFilters data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the portFilters resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/protocolfilters/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/protocolfilters/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/protocolfilters/protocolfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/protocolfilters/protocolfilters.py new file mode 100644 index 000000000..6b9e07bef --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23nextgenprotocolfilter/protocolfilters/protocolfilters.py @@ -0,0 +1,143 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class ProtocolFilters(Base): + """Contains list of all the protocols available which can be enabled for the custom view. + The ProtocolFilters class encapsulates a list of protocolFilters resources that are managed by the system. + A list of resources can be retrieved from the server using the ProtocolFilters.find() method. + """ + + __slots__ = () + _SDM_NAME = "protocolFilters" + _SDM_ATT_MAP = { + "Enabled": "enabled", + "Name": "name", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(ProtocolFilters, self).__init__(parent, list_op) + + @property + def Enabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: Value determining whether the filter is selected or not + """ + return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) + + @Enabled.setter + def Enabled(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Protocol Filter Name. + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + def update(self, Enabled=None): + # type: (bool) -> ProtocolFilters + """Updates protocolFilters resource on the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Enabled=None): + # type: (bool) -> ProtocolFilters + """Adds a new protocolFilters resource on the json, only valid with batch add utility + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Returns + ------- + - self: This instance with all currently retrieved protocolFilters resources using find and the newly added protocolFilters resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Enabled=None, Name=None): + # type: (bool, str) -> ProtocolFilters + """Finds and retrieves protocolFilters resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve protocolFilters resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all protocolFilters resources from the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - Name (str): Protocol Filter Name. + + Returns + ------- + - self: This instance with matching protocolFilters resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of protocolFilters data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the protocolFilters resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolauthaccessfilter/layer23protocolauthaccessfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolauthaccessfilter/layer23protocolauthaccessfilter.py index 1b58cfbd2..a8afbcef3 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolauthaccessfilter/layer23protocolauthaccessfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolauthaccessfilter/layer23protocolauthaccessfilter.py @@ -45,13 +45,53 @@ class Layer23ProtocolAuthAccessFilter(Base): def __init__(self, parent, list_op=False): super(Layer23ProtocolAuthAccessFilter, self).__init__(parent, list_op) + @property + def PortFilters(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23protocolauthaccessfilter.portfilters.portfilters.PortFilters): An instance of the PortFilters class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23protocolauthaccessfilter.portfilters.portfilters import ( + PortFilters, + ) + + if len(self._object_properties) > 0: + if self._properties.get("PortFilters", None) is not None: + return self._properties.get("PortFilters") + return PortFilters(self) + + @property + def ProtocolFilters(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23protocolauthaccessfilter.protocolfilters.protocolfilters.ProtocolFilters): An instance of the ProtocolFilters class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23protocolauthaccessfilter.protocolfilters.protocolfilters import ( + ProtocolFilters, + ) + + if len(self._object_properties) > 0: + if self._properties.get("ProtocolFilters", None) is not None: + return self._properties.get("ProtocolFilters") + return ProtocolFilters(self) + @property def PortFilterIds(self): # type: () -> List[str] """ Returns ------- - - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter]): Ports that have been filtered. + - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter]): Ports that have been filtered. """ return self._get_attribute(self._SDM_ATT_MAP["PortFilterIds"]) @@ -66,7 +106,7 @@ def ProtocolFilterIds(self): """ Returns ------- - - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolFilter]): Protocols that have been filtered. + - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolFilter]): Protocols that have been filtered. """ return self._get_attribute(self._SDM_ATT_MAP["ProtocolFilterIds"]) @@ -81,8 +121,8 @@ def update(self, PortFilterIds=None, ProtocolFilterIds=None): Args ---- - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Ports that have been filtered. - - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolFilter])): Protocols that have been filtered. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Ports that have been filtered. + - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolFilter])): Protocols that have been filtered. Raises ------ @@ -96,8 +136,8 @@ def add(self, PortFilterIds=None, ProtocolFilterIds=None): Args ---- - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Ports that have been filtered. - - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolFilter])): Protocols that have been filtered. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Ports that have been filtered. + - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolFilter])): Protocols that have been filtered. Returns ------- @@ -129,8 +169,8 @@ def find(self, PortFilterIds=None, ProtocolFilterIds=None): Args ---- - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Ports that have been filtered. - - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolFilter])): Protocols that have been filtered. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Ports that have been filtered. + - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolFilter])): Protocols that have been filtered. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolauthaccessfilter/portfilters/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolauthaccessfilter/portfilters/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolauthaccessfilter/portfilters/portfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolauthaccessfilter/portfilters/portfilters.py new file mode 100644 index 000000000..2538e347b --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolauthaccessfilter/portfilters/portfilters.py @@ -0,0 +1,143 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class PortFilters(Base): + """Contains list of all the ports available which can be enabled for the custom view. + The PortFilters class encapsulates a list of portFilters resources that are managed by the system. + A list of resources can be retrieved from the server using the PortFilters.find() method. + """ + + __slots__ = () + _SDM_NAME = "portFilters" + _SDM_ATT_MAP = { + "Enabled": "enabled", + "Name": "name", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(PortFilters, self).__init__(parent, list_op) + + @property + def Enabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: Value determining whether the filter is selected or not + """ + return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) + + @Enabled.setter + def Enabled(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Selected port filters from the Port Filter list. + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + def update(self, Enabled=None): + # type: (bool) -> PortFilters + """Updates portFilters resource on the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Enabled=None): + # type: (bool) -> PortFilters + """Adds a new portFilters resource on the json, only valid with batch add utility + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Returns + ------- + - self: This instance with all currently retrieved portFilters resources using find and the newly added portFilters resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Enabled=None, Name=None): + # type: (bool, str) -> PortFilters + """Finds and retrieves portFilters resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve portFilters resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all portFilters resources from the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - Name (str): Selected port filters from the Port Filter list. + + Returns + ------- + - self: This instance with matching portFilters resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of portFilters data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the portFilters resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolauthaccessfilter/protocolfilters/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolauthaccessfilter/protocolfilters/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolauthaccessfilter/protocolfilters/protocolfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolauthaccessfilter/protocolfilters/protocolfilters.py new file mode 100644 index 000000000..6b9e07bef --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolauthaccessfilter/protocolfilters/protocolfilters.py @@ -0,0 +1,143 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class ProtocolFilters(Base): + """Contains list of all the protocols available which can be enabled for the custom view. + The ProtocolFilters class encapsulates a list of protocolFilters resources that are managed by the system. + A list of resources can be retrieved from the server using the ProtocolFilters.find() method. + """ + + __slots__ = () + _SDM_NAME = "protocolFilters" + _SDM_ATT_MAP = { + "Enabled": "enabled", + "Name": "name", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(ProtocolFilters, self).__init__(parent, list_op) + + @property + def Enabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: Value determining whether the filter is selected or not + """ + return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) + + @Enabled.setter + def Enabled(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Protocol Filter Name. + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + def update(self, Enabled=None): + # type: (bool) -> ProtocolFilters + """Updates protocolFilters resource on the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Enabled=None): + # type: (bool) -> ProtocolFilters + """Adds a new protocolFilters resource on the json, only valid with batch add utility + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Returns + ------- + - self: This instance with all currently retrieved protocolFilters resources using find and the newly added protocolFilters resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Enabled=None, Name=None): + # type: (bool, str) -> ProtocolFilters + """Finds and retrieves protocolFilters resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve protocolFilters resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all protocolFilters resources from the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - Name (str): Protocol Filter Name. + + Returns + ------- + - self: This instance with matching protocolFilters resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of protocolFilters data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the protocolFilters resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolportfilter/layer23protocolportfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolportfilter/layer23protocolportfilter.py index 99c2b7935..bf7a52d30 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolportfilter/layer23protocolportfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolportfilter/layer23protocolportfilter.py @@ -44,13 +44,33 @@ class Layer23ProtocolPortFilter(Base): def __init__(self, parent, list_op=False): super(Layer23ProtocolPortFilter, self).__init__(parent, list_op) + @property + def PortFilters(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23protocolportfilter.portfilters.portfilters.PortFilters): An instance of the PortFilters class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23protocolportfilter.portfilters.portfilters import ( + PortFilters, + ) + + if len(self._object_properties) > 0: + if self._properties.get("PortFilters", None) is not None: + return self._properties.get("PortFilters") + return PortFilters(self) + @property def PortFilterIds(self): # type: () -> List[str] """ Returns ------- - - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter]): Selected port filters from the availablePortFilter list. + - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter]): Selected port filters from the availablePortFilter list. """ return self._get_attribute(self._SDM_ATT_MAP["PortFilterIds"]) @@ -65,7 +85,7 @@ def update(self, PortFilterIds=None): Args ---- - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Selected port filters from the availablePortFilter list. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Selected port filters from the availablePortFilter list. Raises ------ @@ -79,7 +99,7 @@ def add(self, PortFilterIds=None): Args ---- - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Selected port filters from the availablePortFilter list. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Selected port filters from the availablePortFilter list. Returns ------- @@ -111,7 +131,7 @@ def find(self, PortFilterIds=None): Args ---- - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Selected port filters from the availablePortFilter list. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Selected port filters from the availablePortFilter list. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolportfilter/portfilters/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolportfilter/portfilters/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolportfilter/portfilters/portfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolportfilter/portfilters/portfilters.py new file mode 100644 index 000000000..2538e347b --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolportfilter/portfilters/portfilters.py @@ -0,0 +1,143 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class PortFilters(Base): + """Contains list of all the ports available which can be enabled for the custom view. + The PortFilters class encapsulates a list of portFilters resources that are managed by the system. + A list of resources can be retrieved from the server using the PortFilters.find() method. + """ + + __slots__ = () + _SDM_NAME = "portFilters" + _SDM_ATT_MAP = { + "Enabled": "enabled", + "Name": "name", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(PortFilters, self).__init__(parent, list_op) + + @property + def Enabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: Value determining whether the filter is selected or not + """ + return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) + + @Enabled.setter + def Enabled(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Selected port filters from the Port Filter list. + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + def update(self, Enabled=None): + # type: (bool) -> PortFilters + """Updates portFilters resource on the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Enabled=None): + # type: (bool) -> PortFilters + """Adds a new portFilters resource on the json, only valid with batch add utility + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Returns + ------- + - self: This instance with all currently retrieved portFilters resources using find and the newly added portFilters resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Enabled=None, Name=None): + # type: (bool, str) -> PortFilters + """Finds and retrieves portFilters resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve portFilters resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all portFilters resources from the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - Name (str): Selected port filters from the Port Filter list. + + Returns + ------- + - self: This instance with matching portFilters resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of portFilters data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the portFilters resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolroutingfilter/layer23protocolroutingfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolroutingfilter/layer23protocolroutingfilter.py index 11eeccfcb..366566718 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolroutingfilter/layer23protocolroutingfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolroutingfilter/layer23protocolroutingfilter.py @@ -45,13 +45,53 @@ class Layer23ProtocolRoutingFilter(Base): def __init__(self, parent, list_op=False): super(Layer23ProtocolRoutingFilter, self).__init__(parent, list_op) + @property + def PortFilters(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23protocolroutingfilter.portfilters.portfilters.PortFilters): An instance of the PortFilters class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23protocolroutingfilter.portfilters.portfilters import ( + PortFilters, + ) + + if len(self._object_properties) > 0: + if self._properties.get("PortFilters", None) is not None: + return self._properties.get("PortFilters") + return PortFilters(self) + + @property + def ProtocolFilters(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23protocolroutingfilter.protocolfilters.protocolfilters.ProtocolFilters): An instance of the ProtocolFilters class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23protocolroutingfilter.protocolfilters.protocolfilters import ( + ProtocolFilters, + ) + + if len(self._object_properties) > 0: + if self._properties.get("ProtocolFilters", None) is not None: + return self._properties.get("ProtocolFilters") + return ProtocolFilters(self) + @property def PortFilterIds(self): # type: () -> List[str] """ Returns ------- - - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter]): Ports that have been filtered. + - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter]): Ports that have been filtered. """ return self._get_attribute(self._SDM_ATT_MAP["PortFilterIds"]) @@ -66,7 +106,7 @@ def ProtocolFilterIds(self): """ Returns ------- - - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolFilter]): Protocols that have been filtered. + - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolFilter]): Protocols that have been filtered. """ return self._get_attribute(self._SDM_ATT_MAP["ProtocolFilterIds"]) @@ -81,8 +121,8 @@ def update(self, PortFilterIds=None, ProtocolFilterIds=None): Args ---- - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Ports that have been filtered. - - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolFilter])): Protocols that have been filtered. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Ports that have been filtered. + - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolFilter])): Protocols that have been filtered. Raises ------ @@ -96,8 +136,8 @@ def add(self, PortFilterIds=None, ProtocolFilterIds=None): Args ---- - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Ports that have been filtered. - - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolFilter])): Protocols that have been filtered. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Ports that have been filtered. + - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolFilter])): Protocols that have been filtered. Returns ------- @@ -129,8 +169,8 @@ def find(self, PortFilterIds=None, ProtocolFilterIds=None): Args ---- - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Ports that have been filtered. - - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolFilter])): Protocols that have been filtered. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Ports that have been filtered. + - ProtocolFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolFilter])): Protocols that have been filtered. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolroutingfilter/portfilters/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolroutingfilter/portfilters/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolroutingfilter/portfilters/portfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolroutingfilter/portfilters/portfilters.py new file mode 100644 index 000000000..2538e347b --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolroutingfilter/portfilters/portfilters.py @@ -0,0 +1,143 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class PortFilters(Base): + """Contains list of all the ports available which can be enabled for the custom view. + The PortFilters class encapsulates a list of portFilters resources that are managed by the system. + A list of resources can be retrieved from the server using the PortFilters.find() method. + """ + + __slots__ = () + _SDM_NAME = "portFilters" + _SDM_ATT_MAP = { + "Enabled": "enabled", + "Name": "name", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(PortFilters, self).__init__(parent, list_op) + + @property + def Enabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: Value determining whether the filter is selected or not + """ + return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) + + @Enabled.setter + def Enabled(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Selected port filters from the Port Filter list. + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + def update(self, Enabled=None): + # type: (bool) -> PortFilters + """Updates portFilters resource on the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Enabled=None): + # type: (bool) -> PortFilters + """Adds a new portFilters resource on the json, only valid with batch add utility + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Returns + ------- + - self: This instance with all currently retrieved portFilters resources using find and the newly added portFilters resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Enabled=None, Name=None): + # type: (bool, str) -> PortFilters + """Finds and retrieves portFilters resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve portFilters resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all portFilters resources from the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - Name (str): Selected port filters from the Port Filter list. + + Returns + ------- + - self: This instance with matching portFilters resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of portFilters data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the portFilters resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolroutingfilter/protocolfilters/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolroutingfilter/protocolfilters/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolroutingfilter/protocolfilters/protocolfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolroutingfilter/protocolfilters/protocolfilters.py new file mode 100644 index 000000000..6b9e07bef --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolroutingfilter/protocolfilters/protocolfilters.py @@ -0,0 +1,143 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class ProtocolFilters(Base): + """Contains list of all the protocols available which can be enabled for the custom view. + The ProtocolFilters class encapsulates a list of protocolFilters resources that are managed by the system. + A list of resources can be retrieved from the server using the ProtocolFilters.find() method. + """ + + __slots__ = () + _SDM_NAME = "protocolFilters" + _SDM_ATT_MAP = { + "Enabled": "enabled", + "Name": "name", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(ProtocolFilters, self).__init__(parent, list_op) + + @property + def Enabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: Value determining whether the filter is selected or not + """ + return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) + + @Enabled.setter + def Enabled(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Protocol Filter Name. + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + def update(self, Enabled=None): + # type: (bool) -> ProtocolFilters + """Updates protocolFilters resource on the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Enabled=None): + # type: (bool) -> ProtocolFilters + """Adds a new protocolFilters resource on the json, only valid with batch add utility + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Returns + ------- + - self: This instance with all currently retrieved protocolFilters resources using find and the newly added protocolFilters resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Enabled=None, Name=None): + # type: (bool, str) -> ProtocolFilters + """Finds and retrieves protocolFilters resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve protocolFilters resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all protocolFilters resources from the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - Name (str): Protocol Filter Name. + + Returns + ------- + - self: This instance with matching protocolFilters resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of protocolFilters data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the protocolFilters resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolstackfilter/layer23protocolstackfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolstackfilter/layer23protocolstackfilter.py index 8b8dd62bb..e501f9fad 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolstackfilter/layer23protocolstackfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23protocolstackfilter/layer23protocolstackfilter.py @@ -86,7 +86,7 @@ def ProtocolStackFilterId(self): """ Returns ------- - - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolStackFilter]): Selected protocol stack filters from the availableProtocolStackFilter list. + - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolStackFilter]): Selected protocol stack filters from the availableProtocolStackFilter list. """ return self._get_attribute(self._SDM_ATT_MAP["ProtocolStackFilterId"]) @@ -116,7 +116,7 @@ def SortingStatistic(self): """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/statistic): The reference statistic by which the data will be sorted in created SV. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../statistic): The reference statistic by which the data will be sorted in created SV. """ return self._get_attribute(self._SDM_ATT_MAP["SortingStatistic"]) @@ -140,9 +140,9 @@ def update( ---- - DrilldownType (str(perRange | perSession)): Emulates perRange or perSession view based on the option seleted. - NumberOfResults (number): Number of traffic flows to be displayed. - - ProtocolStackFilterId (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolStackFilter])): Selected protocol stack filters from the availableProtocolStackFilter list. + - ProtocolStackFilterId (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolStackFilter])): Selected protocol stack filters from the availableProtocolStackFilter list. - SortAscending (bool): Sets the display order of the view. - - SortingStatistic (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/statistic)): The reference statistic by which the data will be sorted in created SV. + - SortingStatistic (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../statistic)): The reference statistic by which the data will be sorted in created SV. Raises ------ @@ -165,9 +165,9 @@ def add( ---- - DrilldownType (str(perRange | perSession)): Emulates perRange or perSession view based on the option seleted. - NumberOfResults (number): Number of traffic flows to be displayed. - - ProtocolStackFilterId (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolStackFilter])): Selected protocol stack filters from the availableProtocolStackFilter list. + - ProtocolStackFilterId (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolStackFilter])): Selected protocol stack filters from the availableProtocolStackFilter list. - SortAscending (bool): Sets the display order of the view. - - SortingStatistic (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/statistic)): The reference statistic by which the data will be sorted in created SV. + - SortingStatistic (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../statistic)): The reference statistic by which the data will be sorted in created SV. Returns ------- @@ -208,9 +208,9 @@ def find( ---- - DrilldownType (str(perRange | perSession)): Emulates perRange or perSession view based on the option seleted. - NumberOfResults (number): Number of traffic flows to be displayed. - - ProtocolStackFilterId (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableProtocolStackFilter])): Selected protocol stack filters from the availableProtocolStackFilter list. + - ProtocolStackFilterId (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableProtocolStackFilter])): Selected protocol stack filters from the availableProtocolStackFilter list. - SortAscending (bool): Sets the display order of the view. - - SortingStatistic (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/statistic)): The reference statistic by which the data will be sorted in created SV. + - SortingStatistic (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../statistic)): The reference statistic by which the data will be sorted in created SV. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/allflowsfilter/allflowsfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/allflowsfilter/allflowsfilter.py index 294177336..c10c3231e 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/allflowsfilter/allflowsfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/allflowsfilter/allflowsfilter.py @@ -69,7 +69,7 @@ def SortByStatisticId(self): """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableStatisticFilter): The reference statistic by which the data will be sorted in created SV. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableStatisticFilter): The reference statistic by which the data will be sorted in created SV. """ return self._get_attribute(self._SDM_ATT_MAP["SortByStatisticId"]) @@ -102,7 +102,7 @@ def update( Args ---- - NumberOfResults (number): Number of traffic flows to be displayed. - - SortByStatisticId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableStatisticFilter)): The reference statistic by which the data will be sorted in created SV. + - SortByStatisticId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableStatisticFilter)): The reference statistic by which the data will be sorted in created SV. - SortingCondition (str(bestPerformers | worstPerformers)): Sets the display order of the view. Raises @@ -118,7 +118,7 @@ def add(self, NumberOfResults=None, SortByStatisticId=None, SortingCondition=Non Args ---- - NumberOfResults (number): Number of traffic flows to be displayed. - - SortByStatisticId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableStatisticFilter)): The reference statistic by which the data will be sorted in created SV. + - SortByStatisticId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableStatisticFilter)): The reference statistic by which the data will be sorted in created SV. - SortingCondition (str(bestPerformers | worstPerformers)): Sets the display order of the view. Returns @@ -152,7 +152,7 @@ def find(self, NumberOfResults=None, SortByStatisticId=None, SortingCondition=No Args ---- - NumberOfResults (number): Number of traffic flows to be displayed. - - SortByStatisticId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableStatisticFilter)): The reference statistic by which the data will be sorted in created SV. + - SortByStatisticId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableStatisticFilter)): The reference statistic by which the data will be sorted in created SV. - SortingCondition (str(bestPerformers | worstPerformers)): Sets the display order of the view. Returns diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/layer23trafficflowdetectivefilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/layer23trafficflowdetectivefilter.py index 373034567..e2d240a25 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/layer23trafficflowdetectivefilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/layer23trafficflowdetectivefilter.py @@ -40,6 +40,7 @@ class Layer23TrafficFlowDetectiveFilter(Base): "DeadFlowsCount": "deadFlowsCount", "DeadFlowsThreshold": "deadFlowsThreshold", "FlowFilterType": "flowFilterType", + "NumberOfResults": "numberOfResults", "PortFilterIds": "portFilterIds", "ShowEgressFlows": "showEgressFlows", "TrafficItemFilterId": "trafficItemFilterId", @@ -112,6 +113,46 @@ def LiveFlowsFilter(self): return self._properties.get("LiveFlowsFilter") return LiveFlowsFilter(self) + @property + def PortFilters(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficflowdetectivefilter.portfilters.portfilters.PortFilters): An instance of the PortFilters class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficflowdetectivefilter.portfilters.portfilters import ( + PortFilters, + ) + + if len(self._object_properties) > 0: + if self._properties.get("PortFilters", None) is not None: + return self._properties.get("PortFilters") + return PortFilters(self) + + @property + def SortingStatisticsFilters(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficflowdetectivefilter.sortingstatisticsfilters.sortingstatisticsfilters.SortingStatisticsFilters): An instance of the SortingStatisticsFilters class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficflowdetectivefilter.sortingstatisticsfilters.sortingstatisticsfilters import ( + SortingStatisticsFilters, + ) + + if len(self._object_properties) > 0: + if self._properties.get("SortingStatisticsFilters", None) is not None: + return self._properties.get("SortingStatisticsFilters") + return SortingStatisticsFilters(self) + @property def StatisticFilter(self): """ @@ -152,6 +193,26 @@ def TrackingFilter(self): return self._properties.get("TrackingFilter") return TrackingFilter(self) + @property + def TrafficItemFilters(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficflowdetectivefilter.trafficitemfilters.trafficitemfilters.TrafficItemFilters): An instance of the TrafficItemFilters class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficflowdetectivefilter.trafficitemfilters.trafficitemfilters import ( + TrafficItemFilters, + ) + + if len(self._object_properties) > 0: + if self._properties.get("TrafficItemFilters", None) is not None: + return self._properties.get("TrafficItemFilters") + return TrafficItemFilters(self) + @property def DeadFlowsCount(self): # type: () -> int @@ -192,13 +253,28 @@ def FlowFilterType(self, value): # type: (str) -> None self._set_attribute(self._SDM_ATT_MAP["FlowFilterType"], value) + @property + def NumberOfResults(self): + # type: () -> int + """ + Returns + ------- + - number: Number of traffic flows to be displayed. + """ + return self._get_attribute(self._SDM_ATT_MAP["NumberOfResults"]) + + @NumberOfResults.setter + def NumberOfResults(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["NumberOfResults"], value) + @property def PortFilterIds(self): # type: () -> List[str] """ Returns ------- - - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter]): Selected port filters from the availablePortFilter list. + - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter]): Selected port filters from the availablePortFilter list. """ return self._get_attribute(self._SDM_ATT_MAP["PortFilterIds"]) @@ -213,7 +289,7 @@ def ShowEgressFlows(self): """ Returns ------- - - bool: NOT DEFINED + - bool: Is a flag used to fetch the setting whether to show egress flows or not. """ return self._get_attribute(self._SDM_ATT_MAP["ShowEgressFlows"]) @@ -228,7 +304,7 @@ def TrafficItemFilterId(self): """DEPRECATED Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter): Selected traffic flow detective filter from the availableTrafficItemFilter list. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter): Selected traffic flow detective filter from the availableTrafficItemFilter list. """ return self._get_attribute(self._SDM_ATT_MAP["TrafficItemFilterId"]) @@ -243,7 +319,7 @@ def TrafficItemFilterIds(self): """ Returns ------- - - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter]): Selected traffic item filters from the availableTrafficItemFilter list. + - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter]): Selected traffic item filters from the availableTrafficItemFilter list. """ return self._get_attribute(self._SDM_ATT_MAP["TrafficItemFilterIds"]) @@ -256,22 +332,24 @@ def update( self, DeadFlowsThreshold=None, FlowFilterType=None, + NumberOfResults=None, PortFilterIds=None, ShowEgressFlows=None, TrafficItemFilterId=None, TrafficItemFilterIds=None, ): - # type: (int, str, List[str], bool, str, List[str]) -> Layer23TrafficFlowDetectiveFilter + # type: (int, str, int, List[str], bool, str, List[str]) -> Layer23TrafficFlowDetectiveFilter """Updates layer23TrafficFlowDetectiveFilter resource on the server. Args ---- - DeadFlowsThreshold (number): Threshold in seconds after which the flows are declared dead if there are no packets received for a specified number of seconds. This is a global attibute and hence the latest value entered takes precedence over previous values in all the custom views. - FlowFilterType (str(allFlows | deadFlows | liveFlows)): Indicates the flow detective filter settings. - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Selected port filters from the availablePortFilter list. - - ShowEgressFlows (bool): NOT DEFINED - - TrafficItemFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter)): Selected traffic flow detective filter from the availableTrafficItemFilter list. - - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. + - NumberOfResults (number): Number of traffic flows to be displayed. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Selected port filters from the availablePortFilter list. + - ShowEgressFlows (bool): Is a flag used to fetch the setting whether to show egress flows or not. + - TrafficItemFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter)): Selected traffic flow detective filter from the availableTrafficItemFilter list. + - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. Raises ------ @@ -283,22 +361,24 @@ def add( self, DeadFlowsThreshold=None, FlowFilterType=None, + NumberOfResults=None, PortFilterIds=None, ShowEgressFlows=None, TrafficItemFilterId=None, TrafficItemFilterIds=None, ): - # type: (int, str, List[str], bool, str, List[str]) -> Layer23TrafficFlowDetectiveFilter + # type: (int, str, int, List[str], bool, str, List[str]) -> Layer23TrafficFlowDetectiveFilter """Adds a new layer23TrafficFlowDetectiveFilter resource on the server and adds it to the container. Args ---- - DeadFlowsThreshold (number): Threshold in seconds after which the flows are declared dead if there are no packets received for a specified number of seconds. This is a global attibute and hence the latest value entered takes precedence over previous values in all the custom views. - FlowFilterType (str(allFlows | deadFlows | liveFlows)): Indicates the flow detective filter settings. - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Selected port filters from the availablePortFilter list. - - ShowEgressFlows (bool): NOT DEFINED - - TrafficItemFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter)): Selected traffic flow detective filter from the availableTrafficItemFilter list. - - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. + - NumberOfResults (number): Number of traffic flows to be displayed. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Selected port filters from the availablePortFilter list. + - ShowEgressFlows (bool): Is a flag used to fetch the setting whether to show egress flows or not. + - TrafficItemFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter)): Selected traffic flow detective filter from the availableTrafficItemFilter list. + - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. Returns ------- @@ -325,12 +405,13 @@ def find( DeadFlowsCount=None, DeadFlowsThreshold=None, FlowFilterType=None, + NumberOfResults=None, PortFilterIds=None, ShowEgressFlows=None, TrafficItemFilterId=None, TrafficItemFilterIds=None, ): - # type: (int, int, str, List[str], bool, str, List[str]) -> Layer23TrafficFlowDetectiveFilter + # type: (int, int, str, int, List[str], bool, str, List[str]) -> Layer23TrafficFlowDetectiveFilter """Finds and retrieves layer23TrafficFlowDetectiveFilter resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve layer23TrafficFlowDetectiveFilter resources from the server. @@ -342,10 +423,11 @@ def find( - DeadFlowsCount (number): The number of flows declared dead. A flow is declared dead if no traffic is received for a specified number of seconds. To change this threshold use the deadFlowsThreshold attribute. - DeadFlowsThreshold (number): Threshold in seconds after which the flows are declared dead if there are no packets received for a specified number of seconds. This is a global attibute and hence the latest value entered takes precedence over previous values in all the custom views. - FlowFilterType (str(allFlows | deadFlows | liveFlows)): Indicates the flow detective filter settings. - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Selected port filters from the availablePortFilter list. - - ShowEgressFlows (bool): NOT DEFINED - - TrafficItemFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter)): Selected traffic flow detective filter from the availableTrafficItemFilter list. - - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. + - NumberOfResults (number): Number of traffic flows to be displayed. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Selected port filters from the availablePortFilter list. + - ShowEgressFlows (bool): Is a flag used to fetch the setting whether to show egress flows or not. + - TrafficItemFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter)): Selected traffic flow detective filter from the availableTrafficItemFilter list. + - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/liveflowsfilter/liveflowsfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/liveflowsfilter/liveflowsfilter.py index f394f24c8..e742d2eb9 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/liveflowsfilter/liveflowsfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/liveflowsfilter/liveflowsfilter.py @@ -69,7 +69,7 @@ def SortByStatisticId(self): """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableStatisticFilter): The reference statistic by which the data will be sorted in created SV. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableStatisticFilter): The reference statistic by which the data will be sorted in created SV. """ return self._get_attribute(self._SDM_ATT_MAP["SortByStatisticId"]) @@ -102,7 +102,7 @@ def update( Args ---- - NumberOfResults (number): Number of traffic flows to be displayed. - - SortByStatisticId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableStatisticFilter)): The reference statistic by which the data will be sorted in created SV. + - SortByStatisticId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableStatisticFilter)): The reference statistic by which the data will be sorted in created SV. - SortingCondition (str(bestPerformers | worstPerformers)): Sets the display of the view according to best or worst performers. Raises @@ -118,7 +118,7 @@ def add(self, NumberOfResults=None, SortByStatisticId=None, SortingCondition=Non Args ---- - NumberOfResults (number): Number of traffic flows to be displayed. - - SortByStatisticId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableStatisticFilter)): The reference statistic by which the data will be sorted in created SV. + - SortByStatisticId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableStatisticFilter)): The reference statistic by which the data will be sorted in created SV. - SortingCondition (str(bestPerformers | worstPerformers)): Sets the display of the view according to best or worst performers. Returns @@ -152,7 +152,7 @@ def find(self, NumberOfResults=None, SortByStatisticId=None, SortingCondition=No Args ---- - NumberOfResults (number): Number of traffic flows to be displayed. - - SortByStatisticId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableStatisticFilter)): The reference statistic by which the data will be sorted in created SV. + - SortByStatisticId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableStatisticFilter)): The reference statistic by which the data will be sorted in created SV. - SortingCondition (str(bestPerformers | worstPerformers)): Sets the display of the view according to best or worst performers. Returns diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/portfilters/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/portfilters/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/portfilters/portfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/portfilters/portfilters.py new file mode 100644 index 000000000..2538e347b --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/portfilters/portfilters.py @@ -0,0 +1,143 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class PortFilters(Base): + """Contains list of all the ports available which can be enabled for the custom view. + The PortFilters class encapsulates a list of portFilters resources that are managed by the system. + A list of resources can be retrieved from the server using the PortFilters.find() method. + """ + + __slots__ = () + _SDM_NAME = "portFilters" + _SDM_ATT_MAP = { + "Enabled": "enabled", + "Name": "name", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(PortFilters, self).__init__(parent, list_op) + + @property + def Enabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: Value determining whether the filter is selected or not + """ + return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) + + @Enabled.setter + def Enabled(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Selected port filters from the Port Filter list. + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + def update(self, Enabled=None): + # type: (bool) -> PortFilters + """Updates portFilters resource on the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Enabled=None): + # type: (bool) -> PortFilters + """Adds a new portFilters resource on the json, only valid with batch add utility + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Returns + ------- + - self: This instance with all currently retrieved portFilters resources using find and the newly added portFilters resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Enabled=None, Name=None): + # type: (bool, str) -> PortFilters + """Finds and retrieves portFilters resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve portFilters resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all portFilters resources from the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - Name (str): Selected port filters from the Port Filter list. + + Returns + ------- + - self: This instance with matching portFilters resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of portFilters data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the portFilters resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/sortingstatisticsfilters/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/sortingstatisticsfilters/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/sortingstatisticsfilters/sortingstatisticsfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/sortingstatisticsfilters/sortingstatisticsfilters.py new file mode 100644 index 000000000..3f2b1a505 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/sortingstatisticsfilters/sortingstatisticsfilters.py @@ -0,0 +1,143 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class SortingStatisticsFilters(Base): + """Contains list of all the sorting statistics available which can be enabled for the custom view. + The SortingStatisticsFilters class encapsulates a list of sortingStatisticsFilters resources that are managed by the system. + A list of resources can be retrieved from the server using the SortingStatisticsFilters.find() method. + """ + + __slots__ = () + _SDM_NAME = "sortingStatisticsFilters" + _SDM_ATT_MAP = { + "Caption": "caption", + "Enabled": "enabled", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(SortingStatisticsFilters, self).__init__(parent, list_op) + + @property + def Caption(self): + # type: () -> str + """ + Returns + ------- + - str: The reference statistic by which the data will be sorted in created SV. + """ + return self._get_attribute(self._SDM_ATT_MAP["Caption"]) + + @property + def Enabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: Value determining whether the filter is selected or not + """ + return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) + + @Enabled.setter + def Enabled(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) + + def update(self, Enabled=None): + # type: (bool) -> SortingStatisticsFilters + """Updates sortingStatisticsFilters resource on the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Enabled=None): + # type: (bool) -> SortingStatisticsFilters + """Adds a new sortingStatisticsFilters resource on the json, only valid with batch add utility + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Returns + ------- + - self: This instance with all currently retrieved sortingStatisticsFilters resources using find and the newly added sortingStatisticsFilters resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Caption=None, Enabled=None): + # type: (str, bool) -> SortingStatisticsFilters + """Finds and retrieves sortingStatisticsFilters resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve sortingStatisticsFilters resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all sortingStatisticsFilters resources from the server. + + Args + ---- + - Caption (str): The reference statistic by which the data will be sorted in created SV. + - Enabled (bool): Value determining whether the filter is selected or not + + Returns + ------- + - self: This instance with matching sortingStatisticsFilters resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of sortingStatisticsFilters data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the sortingStatisticsFilters resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/statisticfilter/statisticfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/statisticfilter/statisticfilter.py index 9e4a2c2f9..806c28d52 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/statisticfilter/statisticfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/statisticfilter/statisticfilter.py @@ -79,7 +79,7 @@ def StatisticFilterId(self): """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableStatisticFilter): Selected statistic filters from the availableStatisticFilter list. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableStatisticFilter): Selected statistic filters from the availableStatisticFilter list. """ return self._get_attribute(self._SDM_ATT_MAP["StatisticFilterId"]) @@ -94,7 +94,7 @@ def Value(self): """ Returns ------- - - str: Value of statistic to be matched based on operator. + - str: Value of the object. """ return self._get_attribute(self._SDM_ATT_MAP["Value"]) @@ -110,8 +110,8 @@ def update(self, Operator=None, StatisticFilterId=None, Value=None): Args ---- - Operator (str(isAnyOf | isDifferent | isEqual | isEqualOrGreater | isEqualOrSmaller | isGreater | isLike | isNotLike | isSmaller)): The logical operation to be performed. - - StatisticFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableStatisticFilter)): Selected statistic filters from the availableStatisticFilter list. - - Value (str): Value of statistic to be matched based on operator. + - StatisticFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableStatisticFilter)): Selected statistic filters from the availableStatisticFilter list. + - Value (str): Value of the object. Raises ------ @@ -126,8 +126,8 @@ def add(self, Operator=None, StatisticFilterId=None, Value=None): Args ---- - Operator (str(isAnyOf | isDifferent | isEqual | isEqualOrGreater | isEqualOrSmaller | isGreater | isLike | isNotLike | isSmaller)): The logical operation to be performed. - - StatisticFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableStatisticFilter)): Selected statistic filters from the availableStatisticFilter list. - - Value (str): Value of statistic to be matched based on operator. + - StatisticFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableStatisticFilter)): Selected statistic filters from the availableStatisticFilter list. + - Value (str): Value of the object. Returns ------- @@ -160,8 +160,8 @@ def find(self, Operator=None, StatisticFilterId=None, Value=None): Args ---- - Operator (str(isAnyOf | isDifferent | isEqual | isEqualOrGreater | isEqualOrSmaller | isGreater | isLike | isNotLike | isSmaller)): The logical operation to be performed. - - StatisticFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableStatisticFilter)): Selected statistic filters from the availableStatisticFilter list. - - Value (str): Value of statistic to be matched based on operator. + - StatisticFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableStatisticFilter)): Selected statistic filters from the availableStatisticFilter list. + - Value (str): Value of the object. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/trackingfilter/trackingfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/trackingfilter/trackingfilter.py index 1a64ee64c..11af17b71 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/trackingfilter/trackingfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/trackingfilter/trackingfilter.py @@ -79,7 +79,7 @@ def TrackingFilterId(self): """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter): Selected tracking filters from the availableTrackingFilter list. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrackingFilter): Selected tracking filters from the availableTrackingFilter list. """ return self._get_attribute(self._SDM_ATT_MAP["TrackingFilterId"]) @@ -94,7 +94,7 @@ def Value(self): """ Returns ------- - - list(str): Value of the object + - list(str): Value of the object. """ return self._get_attribute(self._SDM_ATT_MAP["Value"]) @@ -110,8 +110,8 @@ def update(self, Operator=None, TrackingFilterId=None, Value=None): Args ---- - Operator (str(isAnyOf | isDifferent | isEqual | isEqualOrGreater | isEqualOrSmaller | isGreater | isInAnyRange | isNoneOf | isSmaller)): The logical operation to be performed. - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. - - Value (list(str)): Value of the object + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. + - Value (list(str)): Value of the object. Raises ------ @@ -126,8 +126,8 @@ def add(self, Operator=None, TrackingFilterId=None, Value=None): Args ---- - Operator (str(isAnyOf | isDifferent | isEqual | isEqualOrGreater | isEqualOrSmaller | isGreater | isInAnyRange | isNoneOf | isSmaller)): The logical operation to be performed. - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. - - Value (list(str)): Value of the object + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. + - Value (list(str)): Value of the object. Returns ------- @@ -160,8 +160,8 @@ def find(self, Operator=None, TrackingFilterId=None, Value=None): Args ---- - Operator (str(isAnyOf | isDifferent | isEqual | isEqualOrGreater | isEqualOrSmaller | isGreater | isInAnyRange | isNoneOf | isSmaller)): The logical operation to be performed. - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. - - Value (list(str)): Value of the object + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. + - Value (list(str)): Value of the object. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/trafficitemfilters/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/trafficitemfilters/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/trafficitemfilters/trafficitemfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/trafficitemfilters/trafficitemfilters.py new file mode 100644 index 000000000..39b905c1a --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowdetectivefilter/trafficitemfilters/trafficitemfilters.py @@ -0,0 +1,155 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class TrafficItemFilters(Base): + """Contains list of all the traffic items available which can be enabled for the custom view. + The TrafficItemFilters class encapsulates a list of trafficItemFilters resources that are managed by the system. + A list of resources can be retrieved from the server using the TrafficItemFilters.find() method. + """ + + __slots__ = () + _SDM_NAME = "trafficItemFilters" + _SDM_ATT_MAP = { + "Enabled": "enabled", + "Name": "name", + "RxPorts": "rxPorts", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(TrafficItemFilters, self).__init__(parent, list_op) + + @property + def Enabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: Value determining whether the filter is selected or not + """ + return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) + + @Enabled.setter + def Enabled(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Selected traffic Item filters from the Traffic Item Filter list. + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @property + def RxPorts(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): Lists down the rx ports associated with the current traffic item filter. + """ + return self._get_attribute(self._SDM_ATT_MAP["RxPorts"]) + + def update(self, Enabled=None): + # type: (bool) -> TrafficItemFilters + """Updates trafficItemFilters resource on the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Enabled=None): + # type: (bool) -> TrafficItemFilters + """Adds a new trafficItemFilters resource on the json, only valid with batch add utility + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Returns + ------- + - self: This instance with all currently retrieved trafficItemFilters resources using find and the newly added trafficItemFilters resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Enabled=None, Name=None, RxPorts=None): + # type: (bool, str, List[str]) -> TrafficItemFilters + """Finds and retrieves trafficItemFilters resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve trafficItemFilters resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all trafficItemFilters resources from the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - Name (str): Selected traffic Item filters from the Traffic Item Filter list. + - RxPorts (list(str)): Lists down the rx ports associated with the current traffic item filter. + + Returns + ------- + - self: This instance with matching trafficItemFilters resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of trafficItemFilters data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the trafficItemFilters resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/enumerationfilter/enumerationfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/enumerationfilter/enumerationfilter.py index 6e7c9322c..55282924f 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/enumerationfilter/enumerationfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/enumerationfilter/enumerationfilter.py @@ -68,7 +68,7 @@ def TrackingFilterId(self): """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter): Selected tracking filters from the availableTrackingFilter list. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrackingFilter): Selected tracking filters from the availableTrackingFilter list. """ return self._get_attribute(self._SDM_ATT_MAP["TrackingFilterId"]) @@ -84,7 +84,7 @@ def update(self, SortDirection=None, TrackingFilterId=None): Args ---- - SortDirection (str(ascending | descending)): Sets the display order of the view. - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. Raises ------ @@ -99,7 +99,7 @@ def add(self, SortDirection=None, TrackingFilterId=None): Args ---- - SortDirection (str(ascending | descending)): Sets the display order of the view. - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. Returns ------- @@ -132,7 +132,7 @@ def find(self, SortDirection=None, TrackingFilterId=None): Args ---- - SortDirection (str(ascending | descending)): Sets the display order of the view. - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/enumerationfilters/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/enumerationfilters/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/enumerationfilters/enumerationfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/enumerationfilters/enumerationfilters.py new file mode 100644 index 000000000..39a0e4e41 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/enumerationfilters/enumerationfilters.py @@ -0,0 +1,176 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class EnumerationFilters(Base): + """Contains list of all the enumeration filters (tracking options) available which can be enabled for the custom view. + The EnumerationFilters class encapsulates a list of enumerationFilters resources that are managed by the system. + A list of resources can be retrieved from the server using the EnumerationFilters.find() method. + """ + + __slots__ = () + _SDM_NAME = "enumerationFilters" + _SDM_ATT_MAP = { + "Enabled": "enabled", + "Name": "name", + "SortDirection": "sortDirection", + "TrackingFilterId": "trackingFilterId", + } + _SDM_ENUM_MAP = { + "sortDirection": ["ascending", "descending"], + } + + def __init__(self, parent, list_op=False): + super(EnumerationFilters, self).__init__(parent, list_op) + + @property + def Enabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: Value determining whether the filter is selected or not + """ + return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) + + @Enabled.setter + def Enabled(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Selected enumeration filters from the tracking Filter list. + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @property + def SortDirection(self): + # type: () -> str + """ + Returns + ------- + - str(ascending | descending): + """ + return self._get_attribute(self._SDM_ATT_MAP["SortDirection"]) + + @SortDirection.setter + def SortDirection(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["SortDirection"], value) + + @property + def TrackingFilterId(self): + # type: () -> str + """ + Returns + ------- + - str: The reference id of available tracking filter. + """ + return self._get_attribute(self._SDM_ATT_MAP["TrackingFilterId"]) + + def update(self, Enabled=None, SortDirection=None): + # type: (bool, str) -> EnumerationFilters + """Updates enumerationFilters resource on the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - SortDirection (str(ascending | descending)): + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Enabled=None, SortDirection=None): + # type: (bool, str) -> EnumerationFilters + """Adds a new enumerationFilters resource on the json, only valid with batch add utility + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - SortDirection (str(ascending | descending)): + + Returns + ------- + - self: This instance with all currently retrieved enumerationFilters resources using find and the newly added enumerationFilters resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Enabled=None, Name=None, SortDirection=None, TrackingFilterId=None): + # type: (bool, str, str, str) -> EnumerationFilters + """Finds and retrieves enumerationFilters resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve enumerationFilters resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all enumerationFilters resources from the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - Name (str): Selected enumeration filters from the tracking Filter list. + - SortDirection (str(ascending | descending)): + - TrackingFilterId (str): The reference id of available tracking filter. + + Returns + ------- + - self: This instance with matching enumerationFilters resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of enumerationFilters data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the enumerationFilters resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/layer23trafficflowfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/layer23trafficflowfilter.py index a6bd6fda1..ec27bc07a 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/layer23trafficflowfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/layer23trafficflowfilter.py @@ -75,6 +75,46 @@ def EnumerationFilter(self): return self._properties.get("EnumerationFilter") return EnumerationFilter(self) + @property + def EnumerationFilters(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficflowfilter.enumerationfilters.enumerationfilters.EnumerationFilters): An instance of the EnumerationFilters class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficflowfilter.enumerationfilters.enumerationfilters import ( + EnumerationFilters, + ) + + if len(self._object_properties) > 0: + if self._properties.get("EnumerationFilters", None) is not None: + return self._properties.get("EnumerationFilters") + return EnumerationFilters(self) + + @property + def PortFilters(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficflowfilter.portfilters.portfilters.PortFilters): An instance of the PortFilters class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficflowfilter.portfilters.portfilters import ( + PortFilters, + ) + + if len(self._object_properties) > 0: + if self._properties.get("PortFilters", None) is not None: + return self._properties.get("PortFilters") + return PortFilters(self) + @property def TrackingFilter(self): """ @@ -95,6 +135,26 @@ def TrackingFilter(self): return self._properties.get("TrackingFilter") return TrackingFilter(self) + @property + def TrafficItemFilters(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficflowfilter.trafficitemfilters.trafficitemfilters.TrafficItemFilters): An instance of the TrafficItemFilters class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficflowfilter.trafficitemfilters.trafficitemfilters import ( + TrafficItemFilters, + ) + + if len(self._object_properties) > 0: + if self._properties.get("TrafficItemFilters", None) is not None: + return self._properties.get("TrafficItemFilters") + return TrafficItemFilters(self) + @property def AggregatedAcrossPorts(self): # type: () -> bool @@ -131,7 +191,7 @@ def PortFilterIds(self): """ Returns ------- - - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter]): Selected port filters from the availablePortFilter list. + - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter]): Selected port filters from the availablePortFilter list. """ return self._get_attribute(self._SDM_ATT_MAP["PortFilterIds"]) @@ -146,7 +206,7 @@ def TrafficItemFilterId(self): """DEPRECATED Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter): Selected traffic item filter from the availableTrafficItemFilter list. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter): Selected traffic item filter from the availableTrafficItemFilter list. """ return self._get_attribute(self._SDM_ATT_MAP["TrafficItemFilterId"]) @@ -161,7 +221,7 @@ def TrafficItemFilterIds(self): """ Returns ------- - - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter]): Selected traffic item filters from the availableTrafficItemFilter list. + - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter]): Selected traffic item filters from the availableTrafficItemFilter list. """ return self._get_attribute(self._SDM_ATT_MAP["TrafficItemFilterIds"]) @@ -185,9 +245,9 @@ def update( ---- - AggregatedAcrossPorts (bool): If true, displays aggregated stat value across ports selected by portFilterIds. Default = false - EgressLatencyBinDisplayOption (str(none | showEgressFlatView | showEgressRows | showLatencyBinStats)): Emulates Latency Bin SV or Egress Tracking SV. - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Selected port filters from the availablePortFilter list. - - TrafficItemFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter)): Selected traffic item filter from the availableTrafficItemFilter list. - - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Selected port filters from the availablePortFilter list. + - TrafficItemFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter)): Selected traffic item filter from the availableTrafficItemFilter list. + - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. Raises ------ @@ -210,9 +270,9 @@ def add( ---- - AggregatedAcrossPorts (bool): If true, displays aggregated stat value across ports selected by portFilterIds. Default = false - EgressLatencyBinDisplayOption (str(none | showEgressFlatView | showEgressRows | showLatencyBinStats)): Emulates Latency Bin SV or Egress Tracking SV. - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Selected port filters from the availablePortFilter list. - - TrafficItemFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter)): Selected traffic item filter from the availableTrafficItemFilter list. - - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Selected port filters from the availablePortFilter list. + - TrafficItemFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter)): Selected traffic item filter from the availableTrafficItemFilter list. + - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. Returns ------- @@ -253,9 +313,9 @@ def find( ---- - AggregatedAcrossPorts (bool): If true, displays aggregated stat value across ports selected by portFilterIds. Default = false - EgressLatencyBinDisplayOption (str(none | showEgressFlatView | showEgressRows | showLatencyBinStats)): Emulates Latency Bin SV or Egress Tracking SV. - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Selected port filters from the availablePortFilter list. - - TrafficItemFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter)): Selected traffic item filter from the availableTrafficItemFilter list. - - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Selected port filters from the availablePortFilter list. + - TrafficItemFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter)): Selected traffic item filter from the availableTrafficItemFilter list. + - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/portfilters/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/portfilters/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/portfilters/portfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/portfilters/portfilters.py new file mode 100644 index 000000000..2538e347b --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/portfilters/portfilters.py @@ -0,0 +1,143 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class PortFilters(Base): + """Contains list of all the ports available which can be enabled for the custom view. + The PortFilters class encapsulates a list of portFilters resources that are managed by the system. + A list of resources can be retrieved from the server using the PortFilters.find() method. + """ + + __slots__ = () + _SDM_NAME = "portFilters" + _SDM_ATT_MAP = { + "Enabled": "enabled", + "Name": "name", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(PortFilters, self).__init__(parent, list_op) + + @property + def Enabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: Value determining whether the filter is selected or not + """ + return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) + + @Enabled.setter + def Enabled(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Selected port filters from the Port Filter list. + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + def update(self, Enabled=None): + # type: (bool) -> PortFilters + """Updates portFilters resource on the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Enabled=None): + # type: (bool) -> PortFilters + """Adds a new portFilters resource on the json, only valid with batch add utility + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Returns + ------- + - self: This instance with all currently retrieved portFilters resources using find and the newly added portFilters resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Enabled=None, Name=None): + # type: (bool, str) -> PortFilters + """Finds and retrieves portFilters resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve portFilters resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all portFilters resources from the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - Name (str): Selected port filters from the Port Filter list. + + Returns + ------- + - self: This instance with matching portFilters resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of portFilters data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the portFilters resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/trackingfilter/trackingfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/trackingfilter/trackingfilter.py index 1a64ee64c..11af17b71 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/trackingfilter/trackingfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/trackingfilter/trackingfilter.py @@ -79,7 +79,7 @@ def TrackingFilterId(self): """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter): Selected tracking filters from the availableTrackingFilter list. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrackingFilter): Selected tracking filters from the availableTrackingFilter list. """ return self._get_attribute(self._SDM_ATT_MAP["TrackingFilterId"]) @@ -94,7 +94,7 @@ def Value(self): """ Returns ------- - - list(str): Value of the object + - list(str): Value of the object. """ return self._get_attribute(self._SDM_ATT_MAP["Value"]) @@ -110,8 +110,8 @@ def update(self, Operator=None, TrackingFilterId=None, Value=None): Args ---- - Operator (str(isAnyOf | isDifferent | isEqual | isEqualOrGreater | isEqualOrSmaller | isGreater | isInAnyRange | isNoneOf | isSmaller)): The logical operation to be performed. - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. - - Value (list(str)): Value of the object + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. + - Value (list(str)): Value of the object. Raises ------ @@ -126,8 +126,8 @@ def add(self, Operator=None, TrackingFilterId=None, Value=None): Args ---- - Operator (str(isAnyOf | isDifferent | isEqual | isEqualOrGreater | isEqualOrSmaller | isGreater | isInAnyRange | isNoneOf | isSmaller)): The logical operation to be performed. - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. - - Value (list(str)): Value of the object + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. + - Value (list(str)): Value of the object. Returns ------- @@ -160,8 +160,8 @@ def find(self, Operator=None, TrackingFilterId=None, Value=None): Args ---- - Operator (str(isAnyOf | isDifferent | isEqual | isEqualOrGreater | isEqualOrSmaller | isGreater | isInAnyRange | isNoneOf | isSmaller)): The logical operation to be performed. - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. - - Value (list(str)): Value of the object + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrackingFilter)): Selected tracking filters from the availableTrackingFilter list. + - Value (list(str)): Value of the object. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/trafficitemfilters/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/trafficitemfilters/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/trafficitemfilters/trafficitemfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/trafficitemfilters/trafficitemfilters.py new file mode 100644 index 000000000..39b905c1a --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficflowfilter/trafficitemfilters/trafficitemfilters.py @@ -0,0 +1,155 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class TrafficItemFilters(Base): + """Contains list of all the traffic items available which can be enabled for the custom view. + The TrafficItemFilters class encapsulates a list of trafficItemFilters resources that are managed by the system. + A list of resources can be retrieved from the server using the TrafficItemFilters.find() method. + """ + + __slots__ = () + _SDM_NAME = "trafficItemFilters" + _SDM_ATT_MAP = { + "Enabled": "enabled", + "Name": "name", + "RxPorts": "rxPorts", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(TrafficItemFilters, self).__init__(parent, list_op) + + @property + def Enabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: Value determining whether the filter is selected or not + """ + return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) + + @Enabled.setter + def Enabled(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Selected traffic Item filters from the Traffic Item Filter list. + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @property + def RxPorts(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): Lists down the rx ports associated with the current traffic item filter. + """ + return self._get_attribute(self._SDM_ATT_MAP["RxPorts"]) + + def update(self, Enabled=None): + # type: (bool) -> TrafficItemFilters + """Updates trafficItemFilters resource on the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Enabled=None): + # type: (bool) -> TrafficItemFilters + """Adds a new trafficItemFilters resource on the json, only valid with batch add utility + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Returns + ------- + - self: This instance with all currently retrieved trafficItemFilters resources using find and the newly added trafficItemFilters resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Enabled=None, Name=None, RxPorts=None): + # type: (bool, str, List[str]) -> TrafficItemFilters + """Finds and retrieves trafficItemFilters resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve trafficItemFilters resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all trafficItemFilters resources from the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - Name (str): Selected traffic Item filters from the Traffic Item Filter list. + - RxPorts (list(str)): Lists down the rx ports associated with the current traffic item filter. + + Returns + ------- + - self: This instance with matching trafficItemFilters resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of trafficItemFilters data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the trafficItemFilters resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficitemfilter/layer23trafficitemfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficitemfilter/layer23trafficitemfilter.py index adced1f75..182468a23 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficitemfilter/layer23trafficitemfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficitemfilter/layer23trafficitemfilter.py @@ -44,13 +44,33 @@ class Layer23TrafficItemFilter(Base): def __init__(self, parent, list_op=False): super(Layer23TrafficItemFilter, self).__init__(parent, list_op) + @property + def TrafficItemFilters(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficitemfilter.trafficitemfilters.trafficitemfilters.TrafficItemFilters): An instance of the TrafficItemFilters class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficitemfilter.trafficitemfilters.trafficitemfilters import ( + TrafficItemFilters, + ) + + if len(self._object_properties) > 0: + if self._properties.get("TrafficItemFilters", None) is not None: + return self._properties.get("TrafficItemFilters") + return TrafficItemFilters(self) + @property def TrafficItemFilterIds(self): # type: () -> List[str] """ Returns ------- - - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter]): Selected traffic item filters from the availableTrafficItemFilter list. + - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter]): Selected traffic item filters from the availableTrafficItemFilter list. """ return self._get_attribute(self._SDM_ATT_MAP["TrafficItemFilterIds"]) @@ -65,7 +85,7 @@ def update(self, TrafficItemFilterIds=None): Args ---- - - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. + - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. Raises ------ @@ -79,7 +99,7 @@ def add(self, TrafficItemFilterIds=None): Args ---- - - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. + - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. Returns ------- @@ -111,7 +131,7 @@ def find(self, TrafficItemFilterIds=None): Args ---- - - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. + - TrafficItemFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableTrafficItemFilter])): Selected traffic item filters from the availableTrafficItemFilter list. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficitemfilter/trafficitemfilters/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficitemfilter/trafficitemfilters/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficitemfilter/trafficitemfilters/trafficitemfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficitemfilter/trafficitemfilters/trafficitemfilters.py new file mode 100644 index 000000000..39b905c1a --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficitemfilter/trafficitemfilters/trafficitemfilters.py @@ -0,0 +1,155 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class TrafficItemFilters(Base): + """Contains list of all the traffic items available which can be enabled for the custom view. + The TrafficItemFilters class encapsulates a list of trafficItemFilters resources that are managed by the system. + A list of resources can be retrieved from the server using the TrafficItemFilters.find() method. + """ + + __slots__ = () + _SDM_NAME = "trafficItemFilters" + _SDM_ATT_MAP = { + "Enabled": "enabled", + "Name": "name", + "RxPorts": "rxPorts", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(TrafficItemFilters, self).__init__(parent, list_op) + + @property + def Enabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: Value determining whether the filter is selected or not + """ + return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) + + @Enabled.setter + def Enabled(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Selected traffic Item filters from the Traffic Item Filter list. + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @property + def RxPorts(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): Lists down the rx ports associated with the current traffic item filter. + """ + return self._get_attribute(self._SDM_ATT_MAP["RxPorts"]) + + def update(self, Enabled=None): + # type: (bool) -> TrafficItemFilters + """Updates trafficItemFilters resource on the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Enabled=None): + # type: (bool) -> TrafficItemFilters + """Adds a new trafficItemFilters resource on the json, only valid with batch add utility + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Returns + ------- + - self: This instance with all currently retrieved trafficItemFilters resources using find and the newly added trafficItemFilters resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Enabled=None, Name=None, RxPorts=None): + # type: (bool, str, List[str]) -> TrafficItemFilters + """Finds and retrieves trafficItemFilters resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve trafficItemFilters resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all trafficItemFilters resources from the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - Name (str): Selected traffic Item filters from the Traffic Item Filter list. + - RxPorts (list(str)): Lists down the rx ports associated with the current traffic item filter. + + Returns + ------- + - self: This instance with matching trafficItemFilters resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of trafficItemFilters data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the trafficItemFilters resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficportfilter/layer23trafficportfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficportfilter/layer23trafficportfilter.py index 4bd2152d2..592e97a4d 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficportfilter/layer23trafficportfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficportfilter/layer23trafficportfilter.py @@ -44,13 +44,33 @@ class Layer23TrafficPortFilter(Base): def __init__(self, parent, list_op=False): super(Layer23TrafficPortFilter, self).__init__(parent, list_op) + @property + def PortFilters(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficportfilter.portfilters.portfilters.PortFilters): An instance of the PortFilters class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.statistics.view.layer23trafficportfilter.portfilters.portfilters import ( + PortFilters, + ) + + if len(self._object_properties) > 0: + if self._properties.get("PortFilters", None) is not None: + return self._properties.get("PortFilters") + return PortFilters(self) + @property def PortFilterIds(self): # type: () -> List[str] """ Returns ------- - - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter]): Selected port filters from the availablePortFilter list. + - list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter]): Selected port filters from the availablePortFilter list. """ return self._get_attribute(self._SDM_ATT_MAP["PortFilterIds"]) @@ -65,7 +85,7 @@ def update(self, PortFilterIds=None): Args ---- - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Selected port filters from the availablePortFilter list. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Selected port filters from the availablePortFilter list. Raises ------ @@ -79,7 +99,7 @@ def add(self, PortFilterIds=None): Args ---- - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Selected port filters from the availablePortFilter list. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Selected port filters from the availablePortFilter list. Returns ------- @@ -111,7 +131,7 @@ def find(self, PortFilterIds=None): Args ---- - - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/availablePortFilter])): Selected port filters from the availablePortFilter list. + - PortFilterIds (list(str[None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availablePortFilter])): Selected port filters from the availablePortFilter list. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficportfilter/portfilters/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficportfilter/portfilters/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficportfilter/portfilters/portfilters.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficportfilter/portfilters/portfilters.py new file mode 100644 index 000000000..2538e347b --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer23trafficportfilter/portfilters/portfilters.py @@ -0,0 +1,143 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class PortFilters(Base): + """Contains list of all the ports available which can be enabled for the custom view. + The PortFilters class encapsulates a list of portFilters resources that are managed by the system. + A list of resources can be retrieved from the server using the PortFilters.find() method. + """ + + __slots__ = () + _SDM_NAME = "portFilters" + _SDM_ATT_MAP = { + "Enabled": "enabled", + "Name": "name", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(PortFilters, self).__init__(parent, list_op) + + @property + def Enabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: Value determining whether the filter is selected or not + """ + return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) + + @Enabled.setter + def Enabled(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Selected port filters from the Port Filter list. + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + def update(self, Enabled=None): + # type: (bool) -> PortFilters + """Updates portFilters resource on the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Enabled=None): + # type: (bool) -> PortFilters + """Adds a new portFilters resource on the json, only valid with batch add utility + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + + Returns + ------- + - self: This instance with all currently retrieved portFilters resources using find and the newly added portFilters resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Enabled=None, Name=None): + # type: (bool, str) -> PortFilters + """Finds and retrieves portFilters resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve portFilters resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all portFilters resources from the server. + + Args + ---- + - Enabled (bool): Value determining whether the filter is selected or not + - Name (str): Selected port filters from the Port Filter list. + + Returns + ------- + - self: This instance with matching portFilters resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of portFilters data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the portFilters resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer47applibrarytrafficfilter/advancedfilter/advancedfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer47applibrarytrafficfilter/advancedfilter/advancedfilter.py index 3328a1b12..d04e53d41 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer47applibrarytrafficfilter/advancedfilter/advancedfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer47applibrarytrafficfilter/advancedfilter/advancedfilter.py @@ -68,7 +68,7 @@ def Name(self): """ Returns ------- - - str: Specifies the filter name. It must be unique per view. + - str: Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. """ return self._get_attribute(self._SDM_ATT_MAP["Name"]) @@ -83,7 +83,7 @@ def SortingStats(self): """ Returns ------- - - str: Specifies the list of statistics by which the view will be sorted. + - str: Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. """ return self._get_attribute(self._SDM_ATT_MAP["SortingStats"]) @@ -98,7 +98,7 @@ def TrackingFilterId(self): """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters): Gets the id of the filter, which is used to add the filter to a view. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters): Gets the id of the filter, which is used to add the filter to a view. """ return self._get_attribute(self._SDM_ATT_MAP["TrackingFilterId"]) @@ -116,9 +116,9 @@ def update( Args ---- - Expression (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. - - Name (str): Specifies the filter name. It must be unique per view. - - SortingStats (str): Specifies the list of statistics by which the view will be sorted. - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters)): Gets the id of the filter, which is used to add the filter to a view. + - Name (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. + - SortingStats (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters)): Gets the id of the filter, which is used to add the filter to a view. Raises ------ @@ -133,9 +133,9 @@ def add(self, Expression=None, Name=None, SortingStats=None, TrackingFilterId=No Args ---- - Expression (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. - - Name (str): Specifies the filter name. It must be unique per view. - - SortingStats (str): Specifies the list of statistics by which the view will be sorted. - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters)): Gets the id of the filter, which is used to add the filter to a view. + - Name (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. + - SortingStats (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters)): Gets the id of the filter, which is used to add the filter to a view. Returns ------- @@ -170,9 +170,9 @@ def find( Args ---- - Expression (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. - - Name (str): Specifies the filter name. It must be unique per view. - - SortingStats (str): Specifies the list of statistics by which the view will be sorted. - - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters)): Gets the id of the filter, which is used to add the filter to a view. + - Name (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. + - SortingStats (str): Specifies the filter body. This is a string that must have a specific format.This can be empty (no filter). The available operations and statistics can be obtained from availableAdvancedFilterOptions. + - TrackingFilterId (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters)): Gets the id of the filter, which is used to add the filter to a view. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer47applibrarytrafficfilter/layer47applibrarytrafficfilter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer47applibrarytrafficfilter/layer47applibrarytrafficfilter.py index 307ee3dcd..1854fea01 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer47applibrarytrafficfilter/layer47applibrarytrafficfilter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/layer47applibrarytrafficfilter/layer47applibrarytrafficfilter.py @@ -74,7 +74,7 @@ def AdvancedFilterName(self): """ Returns ------- - - str: Specifies an advanced filter from the ones available in the selected drill down view. + - str: Selects an advanced filter from the ones available in the selected drill down view. """ return self._get_attribute(self._SDM_ATT_MAP["AdvancedFilterName"]) @@ -89,7 +89,7 @@ def AllAdvancedFilters(self): """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters): Returns a list with all the filters that are present in the selected drill down views. This includes filters that cannot be applied for the current drill down view. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters): Returns a list with all the filters that are present in the selected drill down views. This includes filters that cannot be applied for the current drill down view. """ return self._get_attribute(self._SDM_ATT_MAP["AllAdvancedFilters"]) @@ -99,7 +99,7 @@ def MatchingAdvancedFilters(self): """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters): Specifies a list that contains only the filters which can be applied on the current drill down view. + - str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters): Returns a list that contains only the filters that can be applied on the current drill down view. """ return self._get_attribute(self._SDM_ATT_MAP["MatchingAdvancedFilters"]) @@ -139,7 +139,7 @@ def update(self, AdvancedFilterName=None, TopxEnabled=None, TopxValue=None): Args ---- - - AdvancedFilterName (str): Specifies an advanced filter from the ones available in the selected drill down view. + - AdvancedFilterName (str): Selects an advanced filter from the ones available in the selected drill down view. - TopxEnabled (bool): The view only shows the number of rows specified by TopXValue. If the view is OnDemand, it will become RealTime. - TopxValue (number): The number of rows to be shown when TopXEnabled is set to true. @@ -155,7 +155,7 @@ def add(self, AdvancedFilterName=None, TopxEnabled=None, TopxValue=None): Args ---- - - AdvancedFilterName (str): Specifies an advanced filter from the ones available in the selected drill down view. + - AdvancedFilterName (str): Selects an advanced filter from the ones available in the selected drill down view. - TopxEnabled (bool): The view only shows the number of rows specified by TopXValue. If the view is OnDemand, it will become RealTime. - TopxValue (number): The number of rows to be shown when TopXEnabled is set to true. @@ -196,9 +196,9 @@ def find( Args ---- - - AdvancedFilterName (str): Specifies an advanced filter from the ones available in the selected drill down view. - - AllAdvancedFilters (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters)): Returns a list with all the filters that are present in the selected drill down views. This includes filters that cannot be applied for the current drill down view. - - MatchingAdvancedFilters (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/availableAdvancedFilters)): Specifies a list that contains only the filters which can be applied on the current drill down view. + - AdvancedFilterName (str): Selects an advanced filter from the ones available in the selected drill down view. + - AllAdvancedFilters (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters)): Returns a list with all the filters that are present in the selected drill down views. This includes filters that cannot be applied for the current drill down view. + - MatchingAdvancedFilters (str(None | /api/v1/sessions/1/ixnetwork/statistics/view/.../availableAdvancedFilters)): Returns a list that contains only the filters that can be applied on the current drill down view. - TopxEnabled (bool): The view only shows the number of rows specified by TopXValue. If the view is OnDemand, it will become RealTime. - TopxValue (number): The number of rows to be shown when TopXEnabled is set to true. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/page/egress/egress.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/page/egress/egress.py index dc1feae25..a9e9a26a4 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/page/egress/egress.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/page/egress/egress.py @@ -72,7 +72,7 @@ def CommitEgressPage(self): """ Returns ------- - - bool: Attribute used to commit egress paging from TCL + - bool: Attribute used to commit egress paging from script. """ return self._get_attribute(self._SDM_ATT_MAP["CommitEgressPage"]) @@ -87,7 +87,7 @@ def CurrentPage(self): """ Returns ------- - - number: Determines the current egress page for the indicated ingress page. + - number: The current page number being displayed. """ return self._get_attribute(self._SDM_ATT_MAP["CurrentPage"]) @@ -112,7 +112,7 @@ def TotalPages(self): """ Returns ------- - - number: The total number of egress pages. + - number: The total number of statistics pages. """ return self._get_attribute(self._SDM_ATT_MAP["TotalPages"]) @@ -122,8 +122,8 @@ def update(self, CommitEgressPage=None, CurrentPage=None): Args ---- - - CommitEgressPage (bool): Attribute used to commit egress paging from TCL - - CurrentPage (number): Determines the current egress page for the indicated ingress page. + - CommitEgressPage (bool): Attribute used to commit egress paging from script. + - CurrentPage (number): The current page number being displayed. Raises ------ @@ -137,8 +137,8 @@ def add(self, CommitEgressPage=None, CurrentPage=None): Args ---- - - CommitEgressPage (bool): Attribute used to commit egress paging from TCL - - CurrentPage (number): Determines the current egress page for the indicated ingress page. + - CommitEgressPage (bool): Attribute used to commit egress paging from script. + - CurrentPage (number): The current page number being displayed. Returns ------- @@ -162,10 +162,10 @@ def find( Args ---- - - CommitEgressPage (bool): Attribute used to commit egress paging from TCL - - CurrentPage (number): Determines the current egress page for the indicated ingress page. + - CommitEgressPage (bool): Attribute used to commit egress paging from script. + - CurrentPage (number): The current page number being displayed. - RowCount (number): Displays the particular row number in the view. - - TotalPages (number): The total number of egress pages. + - TotalPages (number): The total number of statistics pages. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/page/page.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/page/page.py index 6fc2f28d8..925665668 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/page/page.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/page/page.py @@ -118,7 +118,7 @@ def ColumnCaptions(self): """ Returns ------- - - list(str): The statistics column caption. + - list(str): The statistics column captions. """ return self._get_attribute(self._SDM_ATT_MAP["ColumnCaptions"]) @@ -208,7 +208,7 @@ def IsReady(self): """ Returns ------- - - bool: If true, the counter is ready to record the statistics. + - bool: If true, the counter is ready to record statistics. """ return self._get_attribute(self._SDM_ATT_MAP["IsReady"]) @@ -233,7 +233,7 @@ def LastPageSize(self): """ Returns ------- - - number: + - number: The number of statistics in the last page. """ return self._get_attribute(self._SDM_ATT_MAP["LastPageSize"]) @@ -306,7 +306,7 @@ def TotalRows(self): """ Returns ------- - - number: NOT DEFINED + - number: Total number of statistic rows. """ return self._get_attribute(self._SDM_ATT_MAP["TotalRows"]) @@ -367,23 +367,23 @@ def find( Args ---- - AllowPaging (bool): If true, statistics will be displayed in multiple pages. - - ColumnCaptions (list(str)): The statistics column caption. + - ColumnCaptions (list(str)): The statistics column captions. - ColumnCount (number): Displays the particular column number in the view. - CurrentPage (number): The current page number being displayed. - EgressMode (str(conditional | paged)): Emulates conditional or paged egress tracking view based on selected mode. - EgressOption (str(rowsWithNoPackets | rowsWithPackets | showAll)): - EgressPageSize (number): The current egress page size across all ingress rows. Default = 3 - IsBlocked (bool): Is a flag used to fetch the status of view (returns true if the views was blocked by Guard Rail, false otherwise) - - IsReady (bool): If true, the counter is ready to record the statistics. + - IsReady (bool): If true, the counter is ready to record statistics. - IsReadyTimeout (number): The maximum time (in seconds) for the -isReady attribute to wait before it returns false in case the page has no data. - - LastPageSize (number): + - LastPageSize (number): The number of statistics in the last page. - PageSize (number): The number of statistics per page. - PageValues (list(list[list[str]])): Returns the values in the current page. The ingress row is grouped with its corresponding egress rows - RowCount (number): Displays the particular row number in the view. - RowValues (dict(arg1:list[list[list[str]]])): All statistics values in a row. - Timestamp (number): Describes the date and time of the event. - TotalPages (number): The total number of statistics pages. - - TotalRows (number): NOT DEFINED + - TotalRows (number): Total number of statistic rows. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/statistic/statistic.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/statistic/statistic.py index 981078bb0..edb04a20c 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/statistic/statistic.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/statistic/statistic.py @@ -87,7 +87,7 @@ def Caption(self): """ Returns ------- - - str: + - str: Name of the statistic. """ return self._get_attribute(self._SDM_ATT_MAP["Caption"]) @@ -102,7 +102,7 @@ def DefaultCaption(self): """ Returns ------- - - str: + - str: Default name of the statistic. """ return self._get_attribute(self._SDM_ATT_MAP["DefaultCaption"]) @@ -112,7 +112,7 @@ def Enabled(self): """ Returns ------- - - bool: + - bool: If true, enables the view that is created. """ return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) @@ -155,8 +155,8 @@ def update( Args ---- - AggregationType (str(average | averageRate | ax | axRate | intervalAverage | min | minRate | none | rate | runStateAgg | runStateAggIgnoreRamp | sum | vectorMax | vectorMin | weightedAverage)): - - Caption (str): - - Enabled (bool): + - Caption (str): Name of the statistic. + - Enabled (bool): If true, enables the view that is created. - ScaleFactor (number): Raises @@ -172,8 +172,8 @@ def add(self, AggregationType=None, Caption=None, Enabled=None, ScaleFactor=None Args ---- - AggregationType (str(average | averageRate | ax | axRate | intervalAverage | min | minRate | none | rate | runStateAgg | runStateAggIgnoreRamp | sum | vectorMax | vectorMin | weightedAverage)): - - Caption (str): - - Enabled (bool): + - Caption (str): Name of the statistic. + - Enabled (bool): If true, enables the view that is created. - ScaleFactor (number): Returns @@ -205,9 +205,9 @@ def find( Args ---- - AggregationType (str(average | averageRate | ax | axRate | intervalAverage | min | minRate | none | rate | runStateAgg | runStateAggIgnoreRamp | sum | vectorMax | vectorMin | weightedAverage)): - - Caption (str): - - DefaultCaption (str): - - Enabled (bool): + - Caption (str): Name of the statistic. + - DefaultCaption (str): Default name of the statistic. + - Enabled (bool): If true, enables the view that is created. - ScaleFactor (number): - SourceTypes (list(str)): diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/view.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/view.py index 4e29a0cb5..2120a3603 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/view.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/statistics/view/view.py @@ -40,6 +40,7 @@ class View(Base): "AutoRefresh": "autoRefresh", "AutoUpdate": "autoUpdate", "AvailableStatsSelectorColumns": "availableStatsSelectorColumns", + "CanDownloadCsvFile": "canDownloadCsvFile", "Caption": "caption", "CsvFileName": "csvFileName", "EnableCsvLogging": "enableCsvLogging", @@ -610,13 +611,23 @@ def AvailableStatsSelectorColumns(self): """ return self._get_attribute(self._SDM_ATT_MAP["AvailableStatsSelectorColumns"]) + @property + def CanDownloadCsvFile(self): + # type: () -> bool + """ + Returns + ------- + - bool: + """ + return self._get_attribute(self._SDM_ATT_MAP["CanDownloadCsvFile"]) + @property def Caption(self): # type: () -> str """ Returns ------- - - str: This is the name that will appear in the GUI stats view window header or in the added view tree from tcl. The caption must be unique. + - str: This is the name that will appear in the GUI stats view window header or in the added view tree from the script. The caption must be unique. """ return self._get_attribute(self._SDM_ATT_MAP["Caption"]) @@ -661,7 +672,7 @@ def Enabled(self): """ Returns ------- - - bool: If true, enables the view that is created from the tcl script. + - bool: If true, enables the view that is created from the script. """ return self._get_attribute(self._SDM_ATT_MAP["Enabled"]) @@ -691,7 +702,7 @@ def OnDemandRefreshView(self): """ Returns ------- - - bool: + - bool: Is a flag which returns whether the view is refreshed on demand. """ return self._get_attribute(self._SDM_ATT_MAP["OnDemandRefreshView"]) @@ -801,7 +812,7 @@ def Visible(self): """ Returns ------- - - bool: If true, displays the custom created tcl SVs in the SV tree under TCL Views node. + - bool: If true, displays the custom created views in the SV tree under TCL Views node. """ return self._get_attribute(self._SDM_ATT_MAP["Visible"]) @@ -832,16 +843,16 @@ def update( ---- - AutoRefresh (bool): If true, automatically refreshes the statistics values. Default = true - AutoUpdate (bool): If true, automatically refreshes the statistics values. Default = true - - Caption (str): This is the name that will appear in the GUI stats view window header or in the added view tree from tcl. The caption must be unique. + - Caption (str): This is the name that will appear in the GUI stats view window header or in the added view tree from the script. The caption must be unique. - CsvFileName (str): Specifies the file name which is used by the CSV Logging feature. The default value is the caption of the view. - EnableCsvLogging (bool): If the CSV Logging feature is enabled the statistics values from a view will be written in a comma separated value format. - - Enabled (bool): If true, enables the view that is created from the tcl script. + - Enabled (bool): If true, enables the view that is created from the script. - EnabledStatsSelectorColumns (list(str)): Columns added from Stat Selector Manager - PageTimeout (number): The statistics view page is timed out based on the time specified. default = 25,000 ms - TimeSeries (bool): If false, then it displays non-timeseries grid views. If true, displays, timeseries line chart view. default = false (non-timeseries) - TreeViewNodeName (str): Displays the name of the tree view node. - Type (str(layer23NextGenProtocol | layer23ProtocolAuthAccess | layer23ProtocolPort | layer23ProtocolRouting | layer23ProtocolStack | layer23TrafficFlow | layer23TrafficFlowDetective | layer23TrafficItem | layer23TrafficPort | layer47AppLibraryTraffic | sVReadOnly)): The type of view the user wants to create from tcl. - - Visible (bool): If true, displays the custom created tcl SVs in the SV tree under TCL Views node. + - Visible (bool): If true, displays the custom created views in the SV tree under TCL Views node. Raises ------ @@ -871,16 +882,16 @@ def add( ---- - AutoRefresh (bool): If true, automatically refreshes the statistics values. Default = true - AutoUpdate (bool): If true, automatically refreshes the statistics values. Default = true - - Caption (str): This is the name that will appear in the GUI stats view window header or in the added view tree from tcl. The caption must be unique. + - Caption (str): This is the name that will appear in the GUI stats view window header or in the added view tree from the script. The caption must be unique. - CsvFileName (str): Specifies the file name which is used by the CSV Logging feature. The default value is the caption of the view. - EnableCsvLogging (bool): If the CSV Logging feature is enabled the statistics values from a view will be written in a comma separated value format. - - Enabled (bool): If true, enables the view that is created from the tcl script. + - Enabled (bool): If true, enables the view that is created from the script. - EnabledStatsSelectorColumns (list(str)): Columns added from Stat Selector Manager - PageTimeout (number): The statistics view page is timed out based on the time specified. default = 25,000 ms - TimeSeries (bool): If false, then it displays non-timeseries grid views. If true, displays, timeseries line chart view. default = false (non-timeseries) - TreeViewNodeName (str): Displays the name of the tree view node. - Type (str(layer23NextGenProtocol | layer23ProtocolAuthAccess | layer23ProtocolPort | layer23ProtocolRouting | layer23ProtocolStack | layer23TrafficFlow | layer23TrafficFlowDetective | layer23TrafficItem | layer23TrafficPort | layer47AppLibraryTraffic | sVReadOnly)): The type of view the user wants to create from tcl. - - Visible (bool): If true, displays the custom created tcl SVs in the SV tree under TCL Views node. + - Visible (bool): If true, displays the custom created views in the SV tree under TCL Views node. Returns ------- @@ -907,6 +918,7 @@ def find( AutoRefresh=None, AutoUpdate=None, AvailableStatsSelectorColumns=None, + CanDownloadCsvFile=None, Caption=None, CsvFileName=None, EnableCsvLogging=None, @@ -923,7 +935,7 @@ def find( ViewCategory=None, Visible=None, ): - # type: (bool, bool, List[str], str, str, bool, bool, List[str], bool, int, bool, bool, bool, str, str, str, str, bool) -> View + # type: (bool, bool, List[str], bool, str, str, bool, bool, List[str], bool, int, bool, bool, bool, str, str, str, str, bool) -> View """Finds and retrieves view resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve view resources from the server. @@ -935,12 +947,13 @@ def find( - AutoRefresh (bool): If true, automatically refreshes the statistics values. Default = true - AutoUpdate (bool): If true, automatically refreshes the statistics values. Default = true - AvailableStatsSelectorColumns (list(str)): Columns available to be added from Stat Selector Manager - - Caption (str): This is the name that will appear in the GUI stats view window header or in the added view tree from tcl. The caption must be unique. + - CanDownloadCsvFile (bool): + - Caption (str): This is the name that will appear in the GUI stats view window header or in the added view tree from the script. The caption must be unique. - CsvFileName (str): Specifies the file name which is used by the CSV Logging feature. The default value is the caption of the view. - EnableCsvLogging (bool): If the CSV Logging feature is enabled the statistics values from a view will be written in a comma separated value format. - - Enabled (bool): If true, enables the view that is created from the tcl script. + - Enabled (bool): If true, enables the view that is created from the script. - EnabledStatsSelectorColumns (list(str)): Columns added from Stat Selector Manager - - OnDemandRefreshView (bool): + - OnDemandRefreshView (bool): Is a flag which returns whether the view is refreshed on demand. - PageTimeout (number): The statistics view page is timed out based on the time specified. default = 25,000 ms - ReadOnly (bool): The default views created by the application will have this attribute set to false. Tcl SV created by user has this value set to true. Based on this attribute value, the user is allowed to modify the SV attributes. - StatsSelectorManager (bool): Flag that denotes whether Stats Selector Manager is enabled for this view or not @@ -949,7 +962,7 @@ def find( - Type (str(layer23NextGenProtocol | layer23ProtocolAuthAccess | layer23ProtocolPort | layer23ProtocolRouting | layer23ProtocolStack | layer23TrafficFlow | layer23TrafficFlowDetective | layer23TrafficItem | layer23TrafficPort | layer47AppLibraryTraffic | sVReadOnly)): The type of view the user wants to create from tcl. - TypeDescription (str): If true, desribes the type - ViewCategory (str(ClassicProtocol | L23Traffic | L47Traffic | Mixed | NextGenProtocol | PerSession | Unknown)): Returns the category of the view based on the type of statistics displayed by the view. - - Visible (bool): If true, displays the custom created tcl SVs in the SV tree under TCL Views node. + - Visible (bool): If true, displays the custom created views in the SV tree under TCL Views node. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/timeline/timeline.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/timeline/timeline.py index b268e3795..7a6e094b9 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/timeline/timeline.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/timeline/timeline.py @@ -28,7 +28,7 @@ class Timeline(Base): - """ + """It helps to run a sequence of QT tests, create configuration with test/protocol and interfaces/traffic items etc. Currently it's supported only in Linux API server The Timeline class encapsulates a required timeline resource which will be retrieved from the server every time the property is accessed. """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpipv6peer_d1a9d481647a51c783f6ad2bd104f872.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpipv6peer_cc4b2c56b540aa17ec1d2d616e50cd4b.py similarity index 99% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpipv6peer_d1a9d481647a51c783f6ad2bd104f872.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpipv6peer_cc4b2c56b540aa17ec1d2d616e50cd4b.py index 8af3b6b69..81e81c4ad 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpipv6peer_d1a9d481647a51c783f6ad2bd104f872.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpipv6peer_cc4b2c56b540aa17ec1d2d616e50cd4b.py @@ -87,6 +87,7 @@ class BgpIpv6Peer(Base): "CapabilityVpls": "capabilityVpls", "Capabilityipv4UnicastFlowSpec": "capabilityipv4UnicastFlowSpec", "Capabilityipv6UnicastFlowSpec": "capabilityipv6UnicastFlowSpec", + "CompressVPNSRv6MicroSID": "compressVPNSRv6MicroSID", "ConfigureKeepaliveTimer": "configureKeepaliveTimer", "ConnectedVia": "connectedVia", "CopyTtl": "copyTtl", @@ -1457,6 +1458,21 @@ def Capabilityipv6UnicastFlowSpec(self): self._get_attribute(self._SDM_ATT_MAP["Capabilityipv6UnicastFlowSpec"]), ) + @property + def CompressVPNSRv6MicroSID(self): + # type: () -> bool + """ + Returns + ------- + - bool: If enabled then VPN with SRv6 micro SID is compressed. + """ + return self._get_attribute(self._SDM_ATT_MAP["CompressVPNSRv6MicroSID"]) + + @CompressVPNSRv6MicroSID.setter + def CompressVPNSRv6MicroSID(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["CompressVPNSRv6MicroSID"], value) + @property def ConfigureKeepaliveTimer(self): # type: () -> 'Multivalue' @@ -3165,6 +3181,7 @@ def update( BgpLsNoOfCommunities=None, CapabilityIpv4MplsAddPath=None, CapabilityIpv6MplsAddPath=None, + CompressVPNSRv6MicroSID=None, ConnectedVia=None, CopyTtl=None, EnSRv6DataPlane=None, @@ -3202,7 +3219,7 @@ def update( UseGSRv6SI=None, UseStaticPolicy=None, ): - # type: (bool, bool, int, int, int, bool, bool, List[str], bool, bool, bool, bool, bool, int, str, bool, bool, bool, bool, int, int, int, int, str, int, int, int, int, int, int, int, bool, int, str, int, int, int, List[str], str, int, int, bool, bool) -> BgpIpv6Peer + # type: (bool, bool, int, int, int, bool, bool, bool, List[str], bool, bool, bool, bool, bool, int, str, bool, bool, bool, bool, int, int, int, int, str, int, int, int, int, int, int, int, bool, int, str, int, int, int, List[str], str, int, int, bool, bool) -> BgpIpv6Peer """Updates bgpIpv6Peer resource on the server. This method has some named parameters with a type: obj (Multivalue). @@ -3217,6 +3234,7 @@ def update( - BgpLsNoOfCommunities (number): Number of Communities - CapabilityIpv4MplsAddPath (bool): IPv4 MPLS Add Path Capability - CapabilityIpv6MplsAddPath (bool): IPv6 MPLS Add Path Capability + - CompressVPNSRv6MicroSID (bool): If enabled then VPN with SRv6 micro SID is compressed. - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of layers this layer is used to connect with to the wire. - CopyTtl (bool): Copy TTL from customer packet to outer IPv6 header - EnSRv6DataPlane (bool): Ingress Peer Supports SRv6 @@ -3269,6 +3287,7 @@ def add( BgpLsNoOfCommunities=None, CapabilityIpv4MplsAddPath=None, CapabilityIpv6MplsAddPath=None, + CompressVPNSRv6MicroSID=None, ConnectedVia=None, CopyTtl=None, EnSRv6DataPlane=None, @@ -3306,7 +3325,7 @@ def add( UseGSRv6SI=None, UseStaticPolicy=None, ): - # type: (bool, bool, int, int, int, bool, bool, List[str], bool, bool, bool, bool, bool, int, str, bool, bool, bool, bool, int, int, int, int, str, int, int, int, int, int, int, int, bool, int, str, int, int, int, List[str], str, int, int, bool, bool) -> BgpIpv6Peer + # type: (bool, bool, int, int, int, bool, bool, bool, List[str], bool, bool, bool, bool, bool, int, str, bool, bool, bool, bool, int, int, int, int, str, int, int, int, int, int, int, int, bool, int, str, int, int, int, List[str], str, int, int, bool, bool) -> BgpIpv6Peer """Adds a new bgpIpv6Peer resource on the server and adds it to the container. Args @@ -3318,6 +3337,7 @@ def add( - BgpLsNoOfCommunities (number): Number of Communities - CapabilityIpv4MplsAddPath (bool): IPv4 MPLS Add Path Capability - CapabilityIpv6MplsAddPath (bool): IPv6 MPLS Add Path Capability + - CompressVPNSRv6MicroSID (bool): If enabled then VPN with SRv6 micro SID is compressed. - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of layers this layer is used to connect with to the wire. - CopyTtl (bool): Copy TTL from customer packet to outer IPv6 header - EnSRv6DataPlane (bool): Ingress Peer Supports SRv6 @@ -3385,6 +3405,7 @@ def find( BgpLsNoOfCommunities=None, CapabilityIpv4MplsAddPath=None, CapabilityIpv6MplsAddPath=None, + CompressVPNSRv6MicroSID=None, ConnectedVia=None, CopyTtl=None, Count=None, @@ -3448,6 +3469,7 @@ def find( - BgpLsNoOfCommunities (number): Number of Communities - CapabilityIpv4MplsAddPath (bool): IPv4 MPLS Add Path Capability - CapabilityIpv6MplsAddPath (bool): IPv6 MPLS Add Path Capability + - CompressVPNSRv6MicroSID (bool): If enabled then VPN with SRv6 micro SID is compressed. - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of layers this layer is used to connect with to the wire. - CopyTtl (bool): Copy TTL from customer packet to outer IPv6 header - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpmvpnsendersitesipv4_4fb28863ad3595e11a7fecc4fbb6ec9d.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpmvpnsendersitesipv4_83c1dffccb6359eeaa27efcb24b1e2a2.py similarity index 97% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpmvpnsendersitesipv4_4fb28863ad3595e11a7fecc4fbb6ec9d.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpmvpnsendersitesipv4_83c1dffccb6359eeaa27efcb24b1e2a2.py index 98532ffe5..12e2d443c 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpmvpnsendersitesipv4_4fb28863ad3595e11a7fecc4fbb6ec9d.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpmvpnsendersitesipv4_83c1dffccb6359eeaa27efcb24b1e2a2.py @@ -46,6 +46,7 @@ class BgpMVpnSenderSitesIpv4(Base): "Ipv4NextHop": "ipv4NextHop", "Ipv6NextHop": "ipv6NextHop", "Name": "name", + "SendSourceActiveADRouteOnStart": "sendSourceActiveADRouteOnStart", "SendTriggeredSourceActiveADRoute": "sendTriggeredSourceActiveADRoute", "SetNextHop": "setNextHop", "SetNextHopIpType": "setNextHopIpType", @@ -251,6 +252,21 @@ def Name(self, value): # type: (str) -> None self._set_attribute(self._SDM_ATT_MAP["Name"], value) + @property + def SendSourceActiveADRouteOnStart(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Send Source Active A-D Route After Starting Protocols. Not Applicable when Send Triggered Source Active A-D Route is enabled. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, + self._get_attribute(self._SDM_ATT_MAP["SendSourceActiveADRouteOnStart"]), + ) + @property def SendTriggeredSourceActiveADRoute(self): # type: () -> 'Multivalue' @@ -588,6 +604,7 @@ def get_device_ids( GroupMaskWidth=None, Ipv4NextHop=None, Ipv6NextHop=None, + SendSourceActiveADRouteOnStart=None, SendTriggeredSourceActiveADRoute=None, SetNextHop=None, SetNextHopIpType=None, @@ -610,6 +627,7 @@ def get_device_ids( - GroupMaskWidth (str): optional regex of groupMaskWidth - Ipv4NextHop (str): optional regex of ipv4NextHop - Ipv6NextHop (str): optional regex of ipv6NextHop + - SendSourceActiveADRouteOnStart (str): optional regex of sendSourceActiveADRouteOnStart - SendTriggeredSourceActiveADRoute (str): optional regex of sendTriggeredSourceActiveADRoute - SetNextHop (str): optional regex of setNextHop - SetNextHopIpType (str): optional regex of setNextHopIpType diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpmvpnsendersitesipv6_3217a8473cfbb135fc2545010c09ffb6.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpmvpnsendersitesipv6_432522ec6a3a94bf0469071086aef3c0.py similarity index 97% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpmvpnsendersitesipv6_3217a8473cfbb135fc2545010c09ffb6.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpmvpnsendersitesipv6_432522ec6a3a94bf0469071086aef3c0.py index 414d0970c..117a282aa 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpmvpnsendersitesipv6_3217a8473cfbb135fc2545010c09ffb6.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpmvpnsendersitesipv6_432522ec6a3a94bf0469071086aef3c0.py @@ -47,6 +47,7 @@ class BgpMVpnSenderSitesIpv6(Base): "Ipv4NextHop": "ipv4NextHop", "Ipv6NextHop": "ipv6NextHop", "Name": "name", + "SendSourceActiveADRouteOnStart": "sendSourceActiveADRouteOnStart", "SendTriggeredSourceActiveADRoute": "sendTriggeredSourceActiveADRoute", "SetNextHop": "setNextHop", "SetNextHopIpType": "setNextHopIpType", @@ -266,6 +267,21 @@ def Name(self, value): # type: (str) -> None self._set_attribute(self._SDM_ATT_MAP["Name"], value) + @property + def SendSourceActiveADRouteOnStart(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Send Source Active A-D Route After Starting Protocols. Not Applicable when Send Triggered Source Active A-D Route is enabled. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, + self._get_attribute(self._SDM_ATT_MAP["SendSourceActiveADRouteOnStart"]), + ) + @property def SendTriggeredSourceActiveADRoute(self): # type: () -> 'Multivalue' @@ -604,6 +620,7 @@ def get_device_ids( IncludeIpv6ExplicitNullLabel=None, Ipv4NextHop=None, Ipv6NextHop=None, + SendSourceActiveADRouteOnStart=None, SendTriggeredSourceActiveADRoute=None, SetNextHop=None, SetNextHopIpType=None, @@ -627,6 +644,7 @@ def get_device_ids( - IncludeIpv6ExplicitNullLabel (str): optional regex of includeIpv6ExplicitNullLabel - Ipv4NextHop (str): optional regex of ipv4NextHop - Ipv6NextHop (str): optional regex of ipv6NextHop + - SendSourceActiveADRouteOnStart (str): optional regex of sendSourceActiveADRouteOnStart - SendTriggeredSourceActiveADRoute (str): optional regex of sendTriggeredSourceActiveADRoute - SetNextHop (str): optional regex of setNextHop - SetNextHopIpType (str): optional regex of setNextHopIpType diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpv6iprouteproperty_e31f5dc41e1565260f4ddeb2f61efe60.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpv6iprouteproperty_e31f5dc41e1565260f4ddeb2f61efe60.py index e18da2c8e..7e8b7972e 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpv6iprouteproperty_e31f5dc41e1565260f4ddeb2f61efe60.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpv6iprouteproperty_e31f5dc41e1565260f4ddeb2f61efe60.py @@ -468,7 +468,7 @@ def AdvSrv6SidInIgp(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Advertise SRv6 SID Locator in IGP (ISIS). + - obj(ixnetwork_restpy.multivalue.Multivalue): Advertise SRv6 SID Locator's Reachability in IGP (ISIS). """ from ixnetwork_restpy.multivalue import Multivalue @@ -1060,7 +1060,7 @@ def IncSrv6SidStructSsTlv(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Enable to include SRv6 SID Structure Sub-Sub TLV for SRv6 Service. + - obj(ixnetwork_restpy.multivalue.Multivalue): Enable to Include SRv6 SID Structure Sub-Sub TLV for SRv6 Service """ from ixnetwork_restpy.multivalue import Multivalue diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpv6l3vpnrouteproperty_15999adbfe8d61825751768ad5e0ddda.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpv6l3vpnrouteproperty_15999adbfe8d61825751768ad5e0ddda.py index b4da94aa1..6614156b8 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpv6l3vpnrouteproperty_15999adbfe8d61825751768ad5e0ddda.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/bgpv6l3vpnrouteproperty_15999adbfe8d61825751768ad5e0ddda.py @@ -351,7 +351,7 @@ def AdvSrv6SidInIgp(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Advertise SRv6 SID Locator in IGP (ISIS) + - obj(ixnetwork_restpy.multivalue.Multivalue): Advertise SRv6 SID Locator's Reachability in IGP (ISIS). """ from ixnetwork_restpy.multivalue import Multivalue diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/dhcpv4client_51940f357e701f382297f94c99af7a22.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/dhcpv4client_51940f357e701f382297f94c99af7a22.py index 500e38bf7..3391a0782 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/dhcpv4client_51940f357e701f382297f94c99af7a22.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/dhcpv4client_51940f357e701f382297f94c99af7a22.py @@ -301,13 +301,13 @@ def Pcc(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_4548de1a5046938dd4962870dfbd425f.Pcc): An instance of the Pcc class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_80e0369b498001415dc4db6533e36cc5.Pcc): An instance of the Pcc class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_4548de1a5046938dd4962870dfbd425f import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_80e0369b498001415dc4db6533e36cc5 import ( Pcc, ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/dhcpv6client_355391ba11ab3c1555c827e2e4ac3c4c.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/dhcpv6client_355391ba11ab3c1555c827e2e4ac3c4c.py index e6102f3b7..109a530c0 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/dhcpv6client_355391ba11ab3c1555c827e2e4ac3c4c.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/dhcpv6client_355391ba11ab3c1555c827e2e4ac3c4c.py @@ -115,13 +115,13 @@ def BgpIpv6Peer(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_d1a9d481647a51c783f6ad2bd104f872.BgpIpv6Peer): An instance of the BgpIpv6Peer class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_cc4b2c56b540aa17ec1d2d616e50cd4b.BgpIpv6Peer): An instance of the BgpIpv6Peer class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_d1a9d481647a51c783f6ad2bd104f872 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_cc4b2c56b540aa17ec1d2d616e50cd4b import ( BgpIpv6Peer, ) @@ -470,6 +470,46 @@ def Dhcp6LearnedInfo(self): return self._properties.get("Dhcp6LearnedInfo") return Dhcp6LearnedInfo(self)._select() + @property + def ECpriRe(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprire_51f1030cbafd2e567d3b517032a1b011.ECpriRe): An instance of the ECpriRe class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprire_51f1030cbafd2e567d3b517032a1b011 import ( + ECpriRe, + ) + + if len(self._object_properties) > 0: + if self._properties.get("ECpriRe", None) is not None: + return self._properties.get("ECpriRe") + return ECpriRe(self) + + @property + def ECpriRec(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprirec_129f1d43f285a4f806ade4e0df814255.ECpriRec): An instance of the ECpriRec class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprirec_129f1d43f285a4f806ade4e0df814255 import ( + ECpriRec, + ) + + if len(self._object_properties) > 0: + if self._properties.get("ECpriRec", None) is not None: + return self._properties.get("ECpriRec") + return ECpriRec(self) + @property def MldHost(self): """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/dotonex_3c5f4866d22ca0e44e5ea4b7ef5bacca.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/dotonex_3c5f4866d22ca0e44e5ea4b7ef5bacca.py index 95e98a75b..b3d599651 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/dotonex_3c5f4866d22ca0e44e5ea4b7ef5bacca.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/dotonex_3c5f4866d22ca0e44e5ea4b7ef5bacca.py @@ -534,13 +534,13 @@ def Macsec(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.macsec_e234f4bb7910f70ddb27cb1e585d5040.Macsec): An instance of the Macsec class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.macsec_8816f28c50db5a9224d83bc7b8e0744d.Macsec): An instance of the Macsec class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.macsec_e234f4bb7910f70ddb27cb1e585d5040 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.macsec_8816f28c50db5a9224d83bc7b8e0744d import ( Macsec, ) @@ -674,13 +674,13 @@ def Ptp(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_24f2907f5a685b611f57469838b21337.Ptp): An instance of the Ptp class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_10b9c21d9c7cf77e86ec2d87b28de348.Ptp): An instance of the Ptp class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_24f2907f5a685b611f57469838b21337 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_10b9c21d9c7cf77e86ec2d87b28de348 import ( Ptp, ) @@ -714,13 +714,13 @@ def StaticMacsec(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.staticmacsec_334bb16ed0f82339d219d0d5f058cee4.StaticMacsec): An instance of the StaticMacsec class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.staticmacsec_b2bfb1c8c259661514373bf3afb4450d.StaticMacsec): An instance of the StaticMacsec class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.staticmacsec_334bb16ed0f82339d219d0d5f058cee4 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.staticmacsec_b2bfb1c8c259661514373bf3afb4450d import ( StaticMacsec, ) @@ -1457,6 +1457,32 @@ def Stop(self, *args, **kwargs): payload[item[0]] = item[1] return self._execute("stop", payload=payload, response_object=None) + def UploadFile(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the uploadFile operation on the server. + + For secure sessions, upload necessary certificate files to chassis before test is run. + + uploadFile(Arg2=list, Arg3=number, Arg4=href, async_operation=bool)list + ----------------------------------------------------------------------- + - Arg2 (list(number)): List of indices into the device group. + - Arg3 (number): Select files(s) to upload. + - Arg4 (obj(ixnetwork_restpy.files.Files)): + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each async action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self.href} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("uploadFile", payload=payload, response_object=None) + def get_device_ids( self, PortNames=None, diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ducarrier_153ae93d502f0581e2ae35d9f51bca07.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ducarrier_153ae93d502f0581e2ae35d9f51bca07.py index 5e00f38fe..725248a30 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ducarrier_153ae93d502f0581e2ae35d9f51bca07.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ducarrier_153ae93d502f0581e2ae35d9f51bca07.py @@ -88,7 +88,7 @@ def BandSectorId(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Band Sector ID. + - obj(ixnetwork_restpy.multivalue.Multivalue): Aggregated Cell identifier which distinguishes bands and sectors supported by O-RU. """ from ixnetwork_restpy.multivalue import Multivalue @@ -112,7 +112,7 @@ def CcId(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): CC ID. + - obj(ixnetwork_restpy.multivalue.Multivalue): CC(Component Carrier) identifier which distinguishes carrier components supported by O-RU. """ from ixnetwork_restpy.multivalue import Multivalue @@ -144,7 +144,7 @@ def DuPortId(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): DU Port ID. + - obj(ixnetwork_restpy.multivalue.Multivalue): DU(Distributed Unit)identifier used to differentiate processing units at DU. """ from ixnetwork_restpy.multivalue import Multivalue @@ -156,7 +156,7 @@ def IqBitwidth(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Depends on the selected compression mthod No compression - represents the bitwidth of each uncompressed I and Q value. Block floating point - represents the bitwidth of each I and Q mantissa value. + - obj(ixnetwork_restpy.multivalue.Multivalue): Depends on the selected compression method. No compression: Represents the bitwidth of each uncompressed I and Q value. Block floating point: Represents the bitwidth of each I and Q mantissa value. """ from ixnetwork_restpy.multivalue import Multivalue @@ -168,7 +168,7 @@ def IqCompMethod(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): IQ Compression Method. + - obj(ixnetwork_restpy.multivalue.Multivalue): Indicates the compression algorithm used for the IQ samples. """ from ixnetwork_restpy.multivalue import Multivalue @@ -195,7 +195,7 @@ def Numerology(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Number which is used in the formula to calculate sub-carrier spacing. + - obj(ixnetwork_restpy.multivalue.Multivalue): Numerology indicates the sub-carrier spacing. """ from ixnetwork_restpy.multivalue import Multivalue @@ -207,7 +207,7 @@ def PrbCount(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Number of PRBs(Physical Resource Blocks). + - obj(ixnetwork_restpy.multivalue.Multivalue): Number of PRBs(Physical Resource Blocks) for a symbol. """ from ixnetwork_restpy.multivalue import Multivalue @@ -219,7 +219,7 @@ def RuPortId(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): RU Port ID. + - obj(ixnetwork_restpy.multivalue.Multivalue): RU(Radio Unit) identifier which designates logical flows. """ from ixnetwork_restpy.multivalue import Multivalue @@ -231,7 +231,7 @@ def SlotFormat(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Configuration of the slot. + - obj(ixnetwork_restpy.multivalue.Multivalue): Configuration of the slot which has 14 symbols. """ from ixnetwork_restpy.multivalue import Multivalue @@ -243,7 +243,7 @@ def Symbol0(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 0 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 0 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -255,7 +255,7 @@ def Symbol1(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 1 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 1 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -267,7 +267,7 @@ def Symbol10(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 10 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 10 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -279,7 +279,7 @@ def Symbol11(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 11 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 11 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -291,7 +291,7 @@ def Symbol12(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 12 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 12 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -303,7 +303,7 @@ def Symbol13(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 13 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 13 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -315,7 +315,7 @@ def Symbol2(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 2 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 2 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -327,7 +327,7 @@ def Symbol3(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 3 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 3 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -339,7 +339,7 @@ def Symbol4(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 4 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 4 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -351,7 +351,7 @@ def Symbol5(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 5 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 5 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -363,7 +363,7 @@ def Symbol6(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 6 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 6 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -375,7 +375,7 @@ def Symbol7(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 7 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 7 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -387,7 +387,7 @@ def Symbol8(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 8 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 8 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -399,7 +399,7 @@ def Symbol9(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 9 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 9 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -411,7 +411,7 @@ def UdCompHeaderInUPlane(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): udCompHeader in U-plane + - obj(ixnetwork_restpy.multivalue.Multivalue): Include udCompHdr value in the U-plane message. """ from ixnetwork_restpy.multivalue import Multivalue diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ducplane_84f46276a04c4895c6fe4e96027e1f05.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ducplane_84f46276a04c4895c6fe4e96027e1f05.py index d4dc23cb2..45d09866c 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ducplane_84f46276a04c4895c6fe4e96027e1f05.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ducplane_84f46276a04c4895c6fe4e96027e1f05.py @@ -28,7 +28,7 @@ class DuCPlane(Base): - """ORAN DU C Plane for traffic wizard. + """ORAN DU C Plane represents the source endpoint used in traffic wizard which is used to configure control message. The DuCPlane class encapsulates a required duCPlane resource which will be retrieved from the server every time the property is accessed. """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ducuplane_552b538c8627003544bf2ab434c809ef.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ducuplane_552b538c8627003544bf2ab434c809ef.py index e284a3868..dcfe07de6 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ducuplane_552b538c8627003544bf2ab434c809ef.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ducuplane_552b538c8627003544bf2ab434c809ef.py @@ -28,7 +28,7 @@ class DuCUPlane(Base): - """ORAN DU CU-Plane for traffic destination endpoint. + """ORAN DU CU-Plane represents the destination endpoint in traffic wizard which is used for both control and user data messages. The DuCUPlane class encapsulates a required duCUPlane resource which will be retrieved from the server every time the property is accessed. """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/duuplane_c9477b2ed619d1459be1f2c472176a7e.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/duuplane_c9477b2ed619d1459be1f2c472176a7e.py index dae50d166..98ebdcffe 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/duuplane_c9477b2ed619d1459be1f2c472176a7e.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/duuplane_c9477b2ed619d1459be1f2c472176a7e.py @@ -28,7 +28,7 @@ class DuUPlane(Base): - """ORAN DU U Plane for traffic wizard. + """ORAN DU U Plane represents the source endpoint used in traffic wizard which is used to configure user data message. The DuUPlane class encapsulates a required duUPlane resource which will be retrieved from the server every time the property is accessed. """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ecprire_51f1030cbafd2e567d3b517032a1b011.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ecprire_51f1030cbafd2e567d3b517032a1b011.py index 194df5495..ca85c2452 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ecprire_51f1030cbafd2e567d3b517032a1b011.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ecprire_51f1030cbafd2e567d3b517032a1b011.py @@ -141,13 +141,13 @@ def OranDU(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.orandu_1cf7f03fca313795b6ed7e94b499b186.OranDU): An instance of the OranDU class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.orandu_3c913d8352aa36ef882a1ba8a0683584.OranDU): An instance of the OranDU class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.orandu_1cf7f03fca313795b6ed7e94b499b186 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.orandu_3c913d8352aa36ef882a1ba8a0683584 import ( OranDU, ) @@ -161,13 +161,13 @@ def OranRU(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.oranru_38317a0c7fd50491419113310eba9bb0.OranRU): An instance of the OranRU class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.oranru_c5d61b81f2557e778753a97ef8b7363b.OranRU): An instance of the OranRU class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.oranru_38317a0c7fd50491419113310eba9bb0 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.oranru_c5d61b81f2557e778753a97ef8b7363b import ( OranRU, ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ecprirec_129f1d43f285a4f806ade4e0df814255.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ecprirec_129f1d43f285a4f806ade4e0df814255.py index bf962681f..b6f729446 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ecprirec_129f1d43f285a4f806ade4e0df814255.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ecprirec_129f1d43f285a4f806ade4e0df814255.py @@ -141,13 +141,13 @@ def OranDU(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.orandu_1cf7f03fca313795b6ed7e94b499b186.OranDU): An instance of the OranDU class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.orandu_3c913d8352aa36ef882a1ba8a0683584.OranDU): An instance of the OranDU class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.orandu_1cf7f03fca313795b6ed7e94b499b186 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.orandu_3c913d8352aa36ef882a1ba8a0683584 import ( OranDU, ) @@ -161,13 +161,13 @@ def OranRU(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.oranru_38317a0c7fd50491419113310eba9bb0.OranRU): An instance of the OranRU class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.oranru_c5d61b81f2557e778753a97ef8b7363b.OranRU): An instance of the OranRU class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.oranru_38317a0c7fd50491419113310eba9bb0 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.oranru_c5d61b81f2557e778753a97ef8b7363b import ( OranRU, ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ethernet_18677f1f170027c217563a3250b1f635.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ethernet_18677f1f170027c217563a3250b1f635.py index 086ef13d3..f322ea448 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ethernet_18677f1f170027c217563a3250b1f635.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ethernet_18677f1f170027c217563a3250b1f635.py @@ -554,13 +554,13 @@ def Macsec(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.macsec_e234f4bb7910f70ddb27cb1e585d5040.Macsec): An instance of the Macsec class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.macsec_8816f28c50db5a9224d83bc7b8e0744d.Macsec): An instance of the Macsec class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.macsec_e234f4bb7910f70ddb27cb1e585d5040 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.macsec_8816f28c50db5a9224d83bc7b8e0744d import ( Macsec, ) @@ -714,13 +714,13 @@ def Ptp(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_24f2907f5a685b611f57469838b21337.Ptp): An instance of the Ptp class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_10b9c21d9c7cf77e86ec2d87b28de348.Ptp): An instance of the Ptp class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_24f2907f5a685b611f57469838b21337 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_10b9c21d9c7cf77e86ec2d87b28de348 import ( Ptp, ) @@ -754,13 +754,13 @@ def StaticMacsec(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.staticmacsec_334bb16ed0f82339d219d0d5f058cee4.StaticMacsec): An instance of the StaticMacsec class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.staticmacsec_b2bfb1c8c259661514373bf3afb4450d.StaticMacsec): An instance of the StaticMacsec class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.staticmacsec_334bb16ed0f82339d219d0d5f058cee4 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.staticmacsec_b2bfb1c8c259661514373bf3afb4450d import ( StaticMacsec, ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv4_8cb960b62ae85a03e1b40a57bfaeb7bb.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv4_8cb960b62ae85a03e1b40a57bfaeb7bb.py index ff19a7f6b..026a1706e 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv4_8cb960b62ae85a03e1b40a57bfaeb7bb.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv4_8cb960b62ae85a03e1b40a57bfaeb7bb.py @@ -637,13 +637,13 @@ def Pcc(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_4548de1a5046938dd4962870dfbd425f.Pcc): An instance of the Pcc class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_80e0369b498001415dc4db6533e36cc5.Pcc): An instance of the Pcc class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_4548de1a5046938dd4962870dfbd425f import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_80e0369b498001415dc4db6533e36cc5 import ( Pcc, ) @@ -697,13 +697,13 @@ def Ptp(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_24f2907f5a685b611f57469838b21337.Ptp): An instance of the Ptp class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_10b9c21d9c7cf77e86ec2d87b28de348.Ptp): An instance of the Ptp class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_24f2907f5a685b611f57469838b21337 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_10b9c21d9c7cf77e86ec2d87b28de348 import ( Ptp, ) @@ -772,6 +772,26 @@ def Tag(self): return self._properties.get("Tag") return Tag(self) + @property + def TwampIpv4(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.twampipv4_f2b0095d1b19a5361901666837fd27ba.TwampIpv4): An instance of the TwampIpv4 class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.twampipv4_f2b0095d1b19a5361901666837fd27ba import ( + TwampIpv4, + ) + + if len(self._object_properties) > 0: + if self._properties.get("TwampIpv4", None) is not None: + return self._properties.get("TwampIpv4") + return TwampIpv4(self) + @property def Vxlan(self): """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv4loopback_f84286c6e2c90f5267670278dde3f258.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv4loopback_f84286c6e2c90f5267670278dde3f258.py index 90855b304..adf5adfec 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv4loopback_f84286c6e2c90f5267670278dde3f258.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv4loopback_f84286c6e2c90f5267670278dde3f258.py @@ -370,13 +370,13 @@ def Pcc(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_4548de1a5046938dd4962870dfbd425f.Pcc): An instance of the Pcc class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_80e0369b498001415dc4db6533e36cc5.Pcc): An instance of the Pcc class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_4548de1a5046938dd4962870dfbd425f import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_80e0369b498001415dc4db6533e36cc5 import ( Pcc, ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv4prefixpools_2d6f2aedde61c058965d4e1b21741352.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv4prefixpools_2d6f2aedde61c058965d4e1b21741352.py index 0451072ef..0964c7716 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv4prefixpools_2d6f2aedde61c058965d4e1b21741352.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv4prefixpools_2d6f2aedde61c058965d4e1b21741352.py @@ -138,13 +138,13 @@ def BgpMVpnSenderSitesIpv4(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv4_4fb28863ad3595e11a7fecc4fbb6ec9d.BgpMVpnSenderSitesIpv4): An instance of the BgpMVpnSenderSitesIpv4 class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv4_83c1dffccb6359eeaa27efcb24b1e2a2.BgpMVpnSenderSitesIpv4): An instance of the BgpMVpnSenderSitesIpv4 class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv4_4fb28863ad3595e11a7fecc4fbb6ec9d import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv4_83c1dffccb6359eeaa27efcb24b1e2a2 import ( BgpMVpnSenderSitesIpv4, ) @@ -158,13 +158,13 @@ def BgpMVpnSenderSitesIpv6(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv6_3217a8473cfbb135fc2545010c09ffb6.BgpMVpnSenderSitesIpv6): An instance of the BgpMVpnSenderSitesIpv6 class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv6_432522ec6a3a94bf0469071086aef3c0.BgpMVpnSenderSitesIpv6): An instance of the BgpMVpnSenderSitesIpv6 class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv6_3217a8473cfbb135fc2545010c09ffb6 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv6_432522ec6a3a94bf0469071086aef3c0 import ( BgpMVpnSenderSitesIpv6, ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6_b40789fa49420009901a46b8dc683afc.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6_b40789fa49420009901a46b8dc683afc.py index 3601af811..65069eb41 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6_b40789fa49420009901a46b8dc683afc.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6_b40789fa49420009901a46b8dc683afc.py @@ -105,13 +105,13 @@ def BgpIpv6Peer(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_d1a9d481647a51c783f6ad2bd104f872.BgpIpv6Peer): An instance of the BgpIpv6Peer class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_cc4b2c56b540aa17ec1d2d616e50cd4b.BgpIpv6Peer): An instance of the BgpIpv6Peer class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_d1a9d481647a51c783f6ad2bd104f872 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_cc4b2c56b540aa17ec1d2d616e50cd4b import ( BgpIpv6Peer, ) @@ -200,6 +200,46 @@ def Dhcpv6server(self): return self._properties.get("Dhcpv6server") return Dhcpv6server(self) + @property + def ECpriRe(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprire_51f1030cbafd2e567d3b517032a1b011.ECpriRe): An instance of the ECpriRe class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprire_51f1030cbafd2e567d3b517032a1b011 import ( + ECpriRe, + ) + + if len(self._object_properties) > 0: + if self._properties.get("ECpriRe", None) is not None: + return self._properties.get("ECpriRe") + return ECpriRe(self) + + @property + def ECpriRec(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprirec_129f1d43f285a4f806ade4e0df814255.ECpriRec): An instance of the ECpriRec class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprirec_129f1d43f285a4f806ade4e0df814255 import ( + ECpriRec, + ) + + if len(self._object_properties) > 0: + if self._properties.get("ECpriRec", None) is not None: + return self._properties.get("ECpriRec") + return ECpriRec(self) + @property def Greoipv6(self): """ @@ -425,13 +465,13 @@ def Ptp(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_24f2907f5a685b611f57469838b21337.Ptp): An instance of the Ptp class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_10b9c21d9c7cf77e86ec2d87b28de348.Ptp): An instance of the Ptp class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_24f2907f5a685b611f57469838b21337 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ptp_10b9c21d9c7cf77e86ec2d87b28de348 import ( Ptp, ) @@ -480,6 +520,26 @@ def Tag(self): return self._properties.get("Tag") return Tag(self) + @property + def TwampIpv6(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.twampipv6_b1455e534d3dddd1d3626dedd3cd5690.TwampIpv6): An instance of the TwampIpv6 class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.twampipv6_b1455e534d3dddd1d3626dedd3cd5690 import ( + TwampIpv6, + ) + + if len(self._object_properties) > 0: + if self._properties.get("TwampIpv6", None) is not None: + return self._properties.get("TwampIpv6") + return TwampIpv6(self) + @property def Vxlanv6(self): """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6autoconfiguration_b065cceda7a3517cca0451a09d81d989.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6autoconfiguration_b065cceda7a3517cca0451a09d81d989.py index c10fab0ef..c480aa186 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6autoconfiguration_b065cceda7a3517cca0451a09d81d989.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6autoconfiguration_b065cceda7a3517cca0451a09d81d989.py @@ -93,13 +93,13 @@ def BgpIpv6Peer(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_d1a9d481647a51c783f6ad2bd104f872.BgpIpv6Peer): An instance of the BgpIpv6Peer class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_cc4b2c56b540aa17ec1d2d616e50cd4b.BgpIpv6Peer): An instance of the BgpIpv6Peer class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_d1a9d481647a51c783f6ad2bd104f872 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_cc4b2c56b540aa17ec1d2d616e50cd4b import ( BgpIpv6Peer, ) @@ -108,6 +108,46 @@ def BgpIpv6Peer(self): return self._properties.get("BgpIpv6Peer") return BgpIpv6Peer(self) + @property + def ECpriRe(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprire_51f1030cbafd2e567d3b517032a1b011.ECpriRe): An instance of the ECpriRe class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprire_51f1030cbafd2e567d3b517032a1b011 import ( + ECpriRe, + ) + + if len(self._object_properties) > 0: + if self._properties.get("ECpriRe", None) is not None: + return self._properties.get("ECpriRe") + return ECpriRe(self) + + @property + def ECpriRec(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprirec_129f1d43f285a4f806ade4e0df814255.ECpriRec): An instance of the ECpriRec class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprirec_129f1d43f285a4f806ade4e0df814255 import ( + ECpriRec, + ) + + if len(self._object_properties) > 0: + if self._properties.get("ECpriRec", None) is not None: + return self._properties.get("ECpriRec") + return ECpriRec(self) + @property def MldHost(self): """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6loopback_c5557054afff2b9cc84b7676de50b805.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6loopback_c5557054afff2b9cc84b7676de50b805.py index ef8d8e37d..ffb382934 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6loopback_c5557054afff2b9cc84b7676de50b805.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6loopback_c5557054afff2b9cc84b7676de50b805.py @@ -90,13 +90,13 @@ def BgpIpv6Peer(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_d1a9d481647a51c783f6ad2bd104f872.BgpIpv6Peer): An instance of the BgpIpv6Peer class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_cc4b2c56b540aa17ec1d2d616e50cd4b.BgpIpv6Peer): An instance of the BgpIpv6Peer class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_d1a9d481647a51c783f6ad2bd104f872 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_cc4b2c56b540aa17ec1d2d616e50cd4b import ( BgpIpv6Peer, ) @@ -125,6 +125,46 @@ def Connector(self): return self._properties.get("Connector") return Connector(self) + @property + def ECpriRe(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprire_51f1030cbafd2e567d3b517032a1b011.ECpriRe): An instance of the ECpriRe class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprire_51f1030cbafd2e567d3b517032a1b011 import ( + ECpriRe, + ) + + if len(self._object_properties) > 0: + if self._properties.get("ECpriRe", None) is not None: + return self._properties.get("ECpriRe") + return ECpriRe(self) + + @property + def ECpriRec(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprirec_129f1d43f285a4f806ade4e0df814255.ECpriRec): An instance of the ECpriRec class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.ecprirec_129f1d43f285a4f806ade4e0df814255 import ( + ECpriRec, + ) + + if len(self._object_properties) > 0: + if self._properties.get("ECpriRec", None) is not None: + return self._properties.get("ECpriRec") + return ECpriRec(self) + @property def Greoipv6(self): """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6prefixpools_f83aba85ff769655b348dc60ddcb30f2.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6prefixpools_f83aba85ff769655b348dc60ddcb30f2.py index 7e30e846c..1f197a039 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6prefixpools_f83aba85ff769655b348dc60ddcb30f2.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ipv6prefixpools_f83aba85ff769655b348dc60ddcb30f2.py @@ -138,13 +138,13 @@ def BgpMVpnSenderSitesIpv4(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv4_4fb28863ad3595e11a7fecc4fbb6ec9d.BgpMVpnSenderSitesIpv4): An instance of the BgpMVpnSenderSitesIpv4 class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv4_83c1dffccb6359eeaa27efcb24b1e2a2.BgpMVpnSenderSitesIpv4): An instance of the BgpMVpnSenderSitesIpv4 class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv4_4fb28863ad3595e11a7fecc4fbb6ec9d import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv4_83c1dffccb6359eeaa27efcb24b1e2a2 import ( BgpMVpnSenderSitesIpv4, ) @@ -158,13 +158,13 @@ def BgpMVpnSenderSitesIpv6(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv6_3217a8473cfbb135fc2545010c09ffb6.BgpMVpnSenderSitesIpv6): An instance of the BgpMVpnSenderSitesIpv6 class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv6_432522ec6a3a94bf0469071086aef3c0.BgpMVpnSenderSitesIpv6): An instance of the BgpMVpnSenderSitesIpv6 class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv6_3217a8473cfbb135fc2545010c09ffb6 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv6_432522ec6a3a94bf0469071086aef3c0 import ( BgpMVpnSenderSitesIpv6, ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/macsec_e234f4bb7910f70ddb27cb1e585d5040.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/macsec_8816f28c50db5a9224d83bc7b8e0744d.py similarity index 99% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/macsec_e234f4bb7910f70ddb27cb1e585d5040.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/macsec_8816f28c50db5a9224d83bc7b8e0744d.py index 15ce91aa5..ef778c7ee 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/macsec_e234f4bb7910f70ddb27cb1e585d5040.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/macsec_8816f28c50db5a9224d83bc7b8e0744d.py @@ -28,7 +28,7 @@ class Macsec(Base): - """MACsec + """Macsec The Macsec class encapsulates a list of macsec resources that are managed by the user. A list of resources can be retrieved from the server using the Macsec.find() method. The list can be managed by using the Macsec.add() and Macsec.remove() methods. @@ -52,6 +52,7 @@ class Macsec(Base): "EncryptedVlanCount": "encryptedVlanCount", "EndStation": "endStation", "Errors": "errors", + "ExcludedProtocols": "excludedProtocols", "IncludeSci": "includeSci", "InterleaveDuration": "interleaveDuration", "InterleaveOldSak": "interleaveOldSak", @@ -867,6 +868,20 @@ def Errors(self): """ return self._get_attribute(self._SDM_ATT_MAP["Errors"]) + @property + def ExcludedProtocols(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Excluded Protocol + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["ExcludedProtocols"]) + ) + @property def IncludeSci(self): # type: () -> 'Multivalue' @@ -1587,6 +1602,7 @@ def get_device_ids( EnableConfidentiality=None, EnableEncryptedVlans=None, EndStation=None, + ExcludedProtocols=None, IncludeSci=None, OverrideTciSetting=None, PnExhaustionBehaviour=None, @@ -1618,6 +1634,7 @@ def get_device_ids( - EnableConfidentiality (str): optional regex of enableConfidentiality - EnableEncryptedVlans (str): optional regex of enableEncryptedVlans - EndStation (str): optional regex of endStation + - ExcludedProtocols (str): optional regex of excludedProtocols - IncludeSci (str): optional regex of includeSci - OverrideTciSetting (str): optional regex of overrideTciSetting - PnExhaustionBehaviour (str): optional regex of pnExhaustionBehaviour diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/mka_263a86da717fe553c3af300d3bfb0cab.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/mka_263a86da717fe553c3af300d3bfb0cab.py index 249b329de..389ce7972 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/mka_263a86da717fe553c3af300d3bfb0cab.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/mka_263a86da717fe553c3af300d3bfb0cab.py @@ -28,7 +28,7 @@ class Mka(Base): - """Mka Configuration + """Mka The Mka class encapsulates a list of mka resources that are managed by the user. A list of resources can be retrieved from the server using the Mka.find() method. The list can be managed by using the Mka.add() and Mka.remove() methods. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/msdpairlist_522227bcb3532730013667b2ead2e53a.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/msdpairlist_522227bcb3532730013667b2ead2e53a.py new file mode 100644 index 000000000..a3902354a --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/msdpairlist_522227bcb3532730013667b2ead2e53a.py @@ -0,0 +1,221 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class MsdPairList(Base): + """MSD Pair List + The MsdPairList class encapsulates a list of msdPairList resources that are managed by the system. + A list of resources can be retrieved from the server using the MsdPairList.find() method. + """ + + __slots__ = () + _SDM_NAME = "msdPairList" + _SDM_ATT_MAP = { + "Count": "count", + "DescriptiveName": "descriptiveName", + "MsdEnable": "msdEnable", + "MsdType": "msdType", + "MsdValue": "msdValue", + "Name": "name", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(MsdPairList, self).__init__(parent, list_op) + + @property + def Count(self): + # type: () -> int + """ + Returns + ------- + - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["Count"]) + + @property + def DescriptiveName(self): + # type: () -> str + """ + Returns + ------- + - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + """ + return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) + + @property + def MsdEnable(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): If this option is checked, then the corresponding MSD Type and Value pair will be advertised as part of the SRv6-PCE-CAPABILITY sub-TLV. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["MsdEnable"])) + + @property + def MsdType(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): The maximum SID depths type. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["MsdType"])) + + @property + def MsdValue(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): The maximum SID depths value. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["MsdValue"])) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + def update(self, Name=None): + # type: (str) -> MsdPairList + """Updates msdPairList resource on the server. + + This method has some named parameters with a type: obj (Multivalue). + The Multivalue class has documentation that details the possible values for those named parameters. + + Args + ---- + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Name=None): + # type: (str) -> MsdPairList + """Adds a new msdPairList resource on the json, only valid with batch add utility + + Args + ---- + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Returns + ------- + - self: This instance with all currently retrieved msdPairList resources using find and the newly added msdPairList resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Count=None, DescriptiveName=None, Name=None): + # type: (int, str, str) -> MsdPairList + """Finds and retrieves msdPairList resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve msdPairList resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all msdPairList resources from the server. + + Args + ---- + - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Returns + ------- + - self: This instance with matching msdPairList resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of msdPairList data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the msdPairList resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) + + def get_device_ids( + self, PortNames=None, MsdEnable=None, MsdType=None, MsdValue=None + ): + """Base class infrastructure that gets a list of msdPairList device ids encapsulated by this object. + + Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. + + Args + ---- + - PortNames (str): optional regex of port names + - MsdEnable (str): optional regex of msdEnable + - MsdType (str): optional regex of msdType + - MsdValue (str): optional regex of msdValue + + Returns + ------- + - list(int): A list of device ids that meets the regex criteria provided in the method parameters + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._get_ngpf_device_ids(locals()) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/networkgroup_4a63874e791827c3a0361c2d201dbc0c.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/networkgroup_4a63874e791827c3a0361c2d201dbc0c.py index 8fb7e1e13..3cdf1f1da 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/networkgroup_4a63874e791827c3a0361c2d201dbc0c.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/networkgroup_4a63874e791827c3a0361c2d201dbc0c.py @@ -135,13 +135,13 @@ def BgpMVpnSenderSitesIpv4(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv4_4fb28863ad3595e11a7fecc4fbb6ec9d.BgpMVpnSenderSitesIpv4): An instance of the BgpMVpnSenderSitesIpv4 class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv4_83c1dffccb6359eeaa27efcb24b1e2a2.BgpMVpnSenderSitesIpv4): An instance of the BgpMVpnSenderSitesIpv4 class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv4_4fb28863ad3595e11a7fecc4fbb6ec9d import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv4_83c1dffccb6359eeaa27efcb24b1e2a2 import ( BgpMVpnSenderSitesIpv4, ) @@ -155,13 +155,13 @@ def BgpMVpnSenderSitesIpv6(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv6_3217a8473cfbb135fc2545010c09ffb6.BgpMVpnSenderSitesIpv6): An instance of the BgpMVpnSenderSitesIpv6 class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv6_432522ec6a3a94bf0469071086aef3c0.BgpMVpnSenderSitesIpv6): An instance of the BgpMVpnSenderSitesIpv6 class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv6_3217a8473cfbb135fc2545010c09ffb6 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpmvpnsendersitesipv6_432522ec6a3a94bf0469071086aef3c0 import ( BgpMVpnSenderSitesIpv6, ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/orandu_1cf7f03fca313795b6ed7e94b499b186.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/orandu_3c913d8352aa36ef882a1ba8a0683584.py similarity index 94% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/orandu_1cf7f03fca313795b6ed7e94b499b186.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/orandu_3c913d8352aa36ef882a1ba8a0683584.py index 47a060ea8..7a22b1f7e 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/orandu_1cf7f03fca313795b6ed7e94b499b186.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/orandu_3c913d8352aa36ef882a1ba8a0683584.py @@ -56,6 +56,7 @@ class OranDU(Base): "StackedLayers": "stackedLayers", "StateCounts": "stateCounts", "Status": "status", + "TrafficClass": "trafficClass", "UPlaneVlanId": "uPlaneVlanId", "UPlaneVlanIdPriority": "uPlaneVlanIdPriority", "UlCPlaneTimingAdvance": "ulCPlaneTimingAdvance", @@ -234,7 +235,7 @@ def DlCPlaneTimingAdvance(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): DL C-Plane Timing Advance (ns) + - obj(ixnetwork_restpy.multivalue.Multivalue): Time by which the Downlink(DL) C-Plane message has to be sent in advance. """ from ixnetwork_restpy.multivalue import Multivalue @@ -248,7 +249,7 @@ def DlUPlaneTimingAdvance(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): DL U-Plane Timing Advance (ns) + - obj(ixnetwork_restpy.multivalue.Multivalue): Time by which the Downlink(DL) U-Plane message has to be sent in advance. """ from ixnetwork_restpy.multivalue import Multivalue @@ -271,7 +272,7 @@ def IpDscp(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Configuration of the IP DSCP value. + - obj(ixnetwork_restpy.multivalue.Multivalue): Configuration of the IP DSCP(Differentiated Services Code Point) value to be carried in the IP header. """ from ixnetwork_restpy.multivalue import Multivalue @@ -343,7 +344,7 @@ def OverrideVlan(self): """ Returns ------- - - bool: Override the ethernet VLAN with this for C-Plane and U-Plane messages. + - bool: Overrides the VLAN configured at Ethernet. Use the overriden value for C-Plane and U-Plane messages. Valid for O-DU/O-RU over Ethernet. """ return self._get_attribute(self._SDM_ATT_MAP["OverrideVlan"]) @@ -396,6 +397,18 @@ def Status(self): """ return self._get_attribute(self._SDM_ATT_MAP["Status"]) + @property + def TrafficClass(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Configuration of the IPv6 DSCP(Differentiated Services Code Point) value to be carried in the IPv6 header. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["TrafficClass"])) + @property def UPlaneVlanId(self): # type: () -> 'Multivalue' @@ -414,7 +427,7 @@ def UPlaneVlanIdPriority(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): 3-bit user priority field in the VLAN tag used for U-Plane messages. + - obj(ixnetwork_restpy.multivalue.Multivalue): 3-bit user priority field in the VLAN tag to be used for U-Plane messages. """ from ixnetwork_restpy.multivalue import Multivalue @@ -428,7 +441,7 @@ def UlCPlaneTimingAdvance(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): UL C-Plane Time Advance (ns) + - obj(ixnetwork_restpy.multivalue.Multivalue): Time by which the Uplink(UL) C-Plane message has to be sent in advance. """ from ixnetwork_restpy.multivalue import Multivalue @@ -459,7 +472,7 @@ def update( - Name (str): Name of NGPF element, guaranteed to be unique in Scenario - NumberOfCarriers (number): Number of carriers to be configured. - NumberOfODuCUPlanes (number): Represents control/user plane of O-DU. - - OverrideVlan (bool): Override the ethernet VLAN with this for C-Plane and U-Plane messages. + - OverrideVlan (bool): Overrides the VLAN configured at Ethernet. Use the overriden value for C-Plane and U-Plane messages. Valid for O-DU/O-RU over Ethernet. - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of secondary (many to one) child layer protocols Raises @@ -488,7 +501,7 @@ def add( - Name (str): Name of NGPF element, guaranteed to be unique in Scenario - NumberOfCarriers (number): Number of carriers to be configured. - NumberOfODuCUPlanes (number): Represents control/user plane of O-DU. - - OverrideVlan (bool): Override the ethernet VLAN with this for C-Plane and U-Plane messages. + - OverrideVlan (bool): Overrides the VLAN configured at Ethernet. Use the overriden value for C-Plane and U-Plane messages. Valid for O-DU/O-RU over Ethernet. - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of secondary (many to one) child layer protocols Returns @@ -543,7 +556,7 @@ def find( - Name (str): Name of NGPF element, guaranteed to be unique in Scenario - NumberOfCarriers (number): Number of carriers to be configured. - NumberOfODuCUPlanes (number): Represents control/user plane of O-DU. - - OverrideVlan (bool): Override the ethernet VLAN with this for C-Plane and U-Plane messages. + - OverrideVlan (bool): Overrides the VLAN configured at Ethernet. Use the overriden value for C-Plane and U-Plane messages. Valid for O-DU/O-RU over Ethernet. - SessionStatus (list(str[down | notStarted | up])): Current state of protocol session: Not Started - session negotiation not started, the session is not active yet. Down - actively trying to bring up a protocol session, but negotiation is didn't successfully complete (yet). Up - session came up successfully. - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of secondary (many to one) child layer protocols - StateCounts (dict(total:number,notStarted:number,down:number,up:number)): A list of values that indicates the total number of sessions, the number of sessions not started, the number of sessions down and the number of sessions that are up @@ -722,6 +735,7 @@ def get_device_ids( DlCPlaneTimingAdvance=None, DlUPlaneTimingAdvance=None, IpDscp=None, + TrafficClass=None, UPlaneVlanId=None, UPlaneVlanIdPriority=None, UlCPlaneTimingAdvance=None, @@ -739,6 +753,7 @@ def get_device_ids( - DlCPlaneTimingAdvance (str): optional regex of dlCPlaneTimingAdvance - DlUPlaneTimingAdvance (str): optional regex of dlUPlaneTimingAdvance - IpDscp (str): optional regex of ipDscp + - TrafficClass (str): optional regex of trafficClass - UPlaneVlanId (str): optional regex of uPlaneVlanId - UPlaneVlanIdPriority (str): optional regex of uPlaneVlanIdPriority - UlCPlaneTimingAdvance (str): optional regex of ulCPlaneTimingAdvance diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/oranru_38317a0c7fd50491419113310eba9bb0.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/oranru_c5d61b81f2557e778753a97ef8b7363b.py similarity index 94% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/oranru_38317a0c7fd50491419113310eba9bb0.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/oranru_c5d61b81f2557e778753a97ef8b7363b.py index ea473d3e0..82309bebb 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/oranru_38317a0c7fd50491419113310eba9bb0.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/oranru_c5d61b81f2557e778753a97ef8b7363b.py @@ -52,6 +52,7 @@ class OranRU(Base): "StackedLayers": "stackedLayers", "StateCounts": "stateCounts", "Status": "status", + "TrafficClass": "trafficClass", "UPlaneVlanId": "uPlaneVlanId", "UPlaneVlanIdPriority": "uPlaneVlanIdPriority", "UlUPlaneTimingDelay": "ulUPlaneTimingDelay", @@ -193,7 +194,7 @@ def IpDscp(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Configuration of the IP DSCP value. + - obj(ixnetwork_restpy.multivalue.Multivalue): Configuration of the IP DSCP(Differentiated Services Code Point) value to be carried in the IP header. """ from ixnetwork_restpy.multivalue import Multivalue @@ -265,7 +266,7 @@ def OverrideVlan(self): """ Returns ------- - - bool: Override the ethernet VLAN with this for C-Plane and U-Plane messages. + - bool: Overrides the VLAN configured at Ethernet. Use the overriden value for C-Plane and U-Plane messages. Valid for O-DU/O-RU over Ethernet. """ return self._get_attribute(self._SDM_ATT_MAP["OverrideVlan"]) @@ -318,6 +319,18 @@ def Status(self): """ return self._get_attribute(self._SDM_ATT_MAP["Status"]) + @property + def TrafficClass(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Configuration of the IPv6 DSCP(Differentiated Services Code Point) value to be carried in the IPv6 header. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["TrafficClass"])) + @property def UPlaneVlanId(self): # type: () -> 'Multivalue' @@ -336,7 +349,7 @@ def UPlaneVlanIdPriority(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): 3-bit user priority field in the VLAN tag used for U-Plane messages. + - obj(ixnetwork_restpy.multivalue.Multivalue): 3-bit user priority field in the VLAN tag to be used for U-Plane messages. """ from ixnetwork_restpy.multivalue import Multivalue @@ -350,7 +363,7 @@ def UlUPlaneTimingDelay(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): UL U-Plane Timing Delay (ns) + - obj(ixnetwork_restpy.multivalue.Multivalue): Time by which the Uplink(UL) U-Plane message has to be delayed. """ from ixnetwork_restpy.multivalue import Multivalue @@ -381,7 +394,7 @@ def update( - Name (str): Name of NGPF element, guaranteed to be unique in Scenario - NumberOfCarriers (number): Number of carriers to be configured. - NumberOfORuCUPlaneList (number): Represents traffic endpoints for O-RU. - - OverrideVlan (bool): Override the ethernet VLAN with this for C-Plane and U-Plane messages. + - OverrideVlan (bool): Overrides the VLAN configured at Ethernet. Use the overriden value for C-Plane and U-Plane messages. Valid for O-DU/O-RU over Ethernet. - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of secondary (many to one) child layer protocols Raises @@ -410,7 +423,7 @@ def add( - Name (str): Name of NGPF element, guaranteed to be unique in Scenario - NumberOfCarriers (number): Number of carriers to be configured. - NumberOfORuCUPlaneList (number): Represents traffic endpoints for O-RU. - - OverrideVlan (bool): Override the ethernet VLAN with this for C-Plane and U-Plane messages. + - OverrideVlan (bool): Overrides the VLAN configured at Ethernet. Use the overriden value for C-Plane and U-Plane messages. Valid for O-DU/O-RU over Ethernet. - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of secondary (many to one) child layer protocols Returns @@ -465,7 +478,7 @@ def find( - Name (str): Name of NGPF element, guaranteed to be unique in Scenario - NumberOfCarriers (number): Number of carriers to be configured. - NumberOfORuCUPlaneList (number): Represents traffic endpoints for O-RU. - - OverrideVlan (bool): Override the ethernet VLAN with this for C-Plane and U-Plane messages. + - OverrideVlan (bool): Overrides the VLAN configured at Ethernet. Use the overriden value for C-Plane and U-Plane messages. Valid for O-DU/O-RU over Ethernet. - SessionStatus (list(str[down | notStarted | up])): Current state of protocol session: Not Started - session negotiation not started, the session is not active yet. Down - actively trying to bring up a protocol session, but negotiation is didn't successfully complete (yet). Up - session came up successfully. - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of secondary (many to one) child layer protocols - StateCounts (dict(total:number,notStarted:number,down:number,up:number)): A list of values that indicates the total number of sessions, the number of sessions not started, the number of sessions down and the number of sessions that are up @@ -640,6 +653,7 @@ def get_device_ids( PortNames=None, Active=None, IpDscp=None, + TrafficClass=None, UPlaneVlanId=None, UPlaneVlanIdPriority=None, UlUPlaneTimingDelay=None, @@ -653,6 +667,7 @@ def get_device_ids( - PortNames (str): optional regex of port names - Active (str): optional regex of active - IpDscp (str): optional regex of ipDscp + - TrafficClass (str): optional regex of trafficClass - UPlaneVlanId (str): optional regex of uPlaneVlanId - UPlaneVlanIdPriority (str): optional regex of uPlaneVlanIdPriority - UlUPlaneTimingDelay (str): optional regex of ulUPlaneTimingDelay diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pcc_4548de1a5046938dd4962870dfbd425f.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pcc_80e0369b498001415dc4db6533e36cc5.py similarity index 94% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pcc_4548de1a5046938dd4962870dfbd425f.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pcc_80e0369b498001415dc4db6533e36cc5.py index acd08beea..4b1963fd0 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pcc_4548de1a5046938dd4962870dfbd425f.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pcc_80e0369b498001415dc4db6533e36cc5.py @@ -54,11 +54,13 @@ class Pcc(Base): "MD5Key": "mD5Key", "MaxLspPerPcReq": "maxLspPerPcReq", "MaxLspsPerPcRpt": "maxLspsPerPcRpt", + "MaxNumberOfMSD": "maxNumberOfMSD", "MaxReconnectInterval": "maxReconnectInterval", "MaxRequestedLspPerInterval": "maxRequestedLspPerInterval", "MaxSyncLspPerInterval": "maxSyncLspPerInterval", "MaximumSidDepth": "maximumSidDepth", "Multiplier": "multiplier", + "NBit": "nBit", "Name": "name", "NumberOfBackupPCEs": "numberOfBackupPCEs", "PccPpagTLVType": "pccPpagTLVType", @@ -73,13 +75,13 @@ class Pcc(Base): "SrPceCapability": "srPceCapability", "Sr_capability_n_flag": "sr_capability_n_flag", "Sr_capability_x_flag": "sr_capability_x_flag", - "Srv6MaxSL": "srv6MaxSL", "Srv6PceCapability": "srv6PceCapability", "StackedLayers": "stackedLayers", "StateCounts": "stateCounts", "StateTimeoutInterval": "stateTimeoutInterval", "Status": "status", "TcpPort": "tcpPort", + "XBit": "xBit", } _SDM_ENUM_MAP = { "status": [ @@ -136,6 +138,26 @@ def LearnedInfo(self): return self._properties.get("LearnedInfo") return LearnedInfo(self) + @property + def MsdPairList(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.msdpairlist_522227bcb3532730013667b2ead2e53a.MsdPairList): An instance of the MsdPairList class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.msdpairlist_522227bcb3532730013667b2ead2e53a import ( + MsdPairList, + ) + + if len(self._object_properties) > 0: + if self._properties.get("MsdPairList", None) is not None: + return self._properties.get("MsdPairList") + return MsdPairList(self) + @property def PccLearnedLspDb(self): """ @@ -181,13 +203,13 @@ def PreEstablishedSrLsps(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.preestablishedsrlsps_a4b5c388b0a9f1cd18fdc396c2ea1c6a.PreEstablishedSrLsps): An instance of the PreEstablishedSrLsps class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.preestablishedsrlsps_c620eef5df7101b5105821449dec19dc.PreEstablishedSrLsps): An instance of the PreEstablishedSrLsps class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.preestablishedsrlsps_a4b5c388b0a9f1cd18fdc396c2ea1c6a import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.preestablishedsrlsps_c620eef5df7101b5105821449dec19dc import ( PreEstablishedSrLsps, ) @@ -434,6 +456,21 @@ def MaxLspsPerPcRpt(self): self, self._get_attribute(self._SDM_ATT_MAP["MaxLspsPerPcRpt"]) ) + @property + def MaxNumberOfMSD(self): + # type: () -> int + """ + Returns + ------- + - number: Maximum number of (MSD-Type ,MSD-Value) pairs that are present in the SRv6-PCE-CAPABILITY sub-TLV. + """ + return self._get_attribute(self._SDM_ATT_MAP["MaxNumberOfMSD"]) + + @MaxNumberOfMSD.setter + def MaxNumberOfMSD(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["MaxNumberOfMSD"], value) + @property def MaxReconnectInterval(self): # type: () -> 'Multivalue' @@ -505,6 +542,18 @@ def Multiplier(self, value): # type: (int) -> None self._set_attribute(self._SDM_ATT_MAP["Multiplier"], value) + @property + def NBit(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): This flag bit is set to True by a PCC to indicate that it is capable of resolving a Node or Adjacency Identifier (NAI) to an SRv6-SID. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["NBit"])) + @property def Name(self): # type: () -> str @@ -555,7 +604,7 @@ def PccTEPathBindingTLVType(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): PCC TE-PATH-BINDING TLV Type is a TLV that carries MPLS label binding or SRv6 Binding SID. This is only configurable if the Binding SID Draft Version is set to ietf-pce-binding-label-sid. The minimum value is 0. The maximum value is 65535. The default value is 31. + - obj(ixnetwork_restpy.multivalue.Multivalue): PCC TE-PATH-BINDING TLV Type is a TLV that carries MPLS label binding or SRv6 Binding SID.This is only configurable if the Binding SID Draft Version is set to ietf-pce-binding-label-sid.The minimum value is 0.The maximum value is 65535.The default value is 31. """ from ixnetwork_restpy.multivalue import Multivalue @@ -583,7 +632,7 @@ def PreEstablishedSrLspsPerPcc(self): """ Returns ------- - - number: Pre-Established SR LSPs per PCC + - number: Pre-Established LSPs per PCC """ return self._get_attribute(self._SDM_ATT_MAP["PreEstablishedSrLspsPerPcc"]) @@ -699,25 +748,13 @@ def Sr_capability_x_flag(self): self, self._get_attribute(self._SDM_ATT_MAP["Sr_capability_x_flag"]) ) - @property - def Srv6MaxSL(self): - # type: () -> 'Multivalue' - """ - Returns - ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): This field specifies the maximum value of the Segments Left (SL) in the SRH. - """ - from ixnetwork_restpy.multivalue import Multivalue - - return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Srv6MaxSL"])) - @property def Srv6PceCapability(self): # type: () -> 'Multivalue' """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): The SRv6 PCE Capability TLV is a sub-TLV that comes under PATH-SETUP-TYPE-CAPABILITY TLV if PST List contains SRv6 PST type. This TLV is associated with the OPEN Object to exchange SRv6 capability of PCEP speakers. + - obj(ixnetwork_restpy.multivalue.Multivalue): The SRv6 PCE Capability TLV is a sub-TLV that comes under PATH-SETUP-TYPE-CAPABILITY TLV if PST List contains SRv6 PST type.This TLV is associated with the OPEN Object to exchange SRv6 capability of PCEP speakers. """ from ixnetwork_restpy.multivalue import Multivalue @@ -785,11 +822,24 @@ def TcpPort(self): return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["TcpPort"])) + @property + def XBit(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): This flag bit is set to True by a PCC to indicate that it does not impose any limit on MSD (irrespective of the MSD-Type). + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["XBit"])) + def update( self, Active_pre_established_lsps=None, ConnectedVia=None, ExpectedInitiatedLspsForTraffic=None, + MaxNumberOfMSD=None, Multiplier=None, Name=None, NumberOfBackupPCEs=None, @@ -797,7 +847,7 @@ def update( RequestedLspsPerPcc=None, StackedLayers=None, ): - # type: (int, List[str], int, int, str, int, int, int, List[str]) -> Pcc + # type: (int, List[str], int, int, int, str, int, int, int, List[str]) -> Pcc """Updates pcc resource on the server. This method has some named parameters with a type: obj (Multivalue). @@ -808,10 +858,11 @@ def update( - Active_pre_established_lsps (number): - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of layers this layer is used to connect with to the wire. - ExpectedInitiatedLspsForTraffic (number): Based on the value in this control the number of Expected Initiated LSPs for Traffic can be configured. This is used for traffic only. + - MaxNumberOfMSD (number): Maximum number of (MSD-Type ,MSD-Value) pairs that are present in the SRv6-PCE-CAPABILITY sub-TLV. - Multiplier (number): Number of layer instances per parent instance (multiplier) - Name (str): Name of NGPF element, guaranteed to be unique in Scenario - NumberOfBackupPCEs (number): Number of Backup PCEs - - PreEstablishedSrLspsPerPcc (number): Pre-Established SR LSPs per PCC + - PreEstablishedSrLspsPerPcc (number): Pre-Established LSPs per PCC - RequestedLspsPerPcc (number): Requested LSPs per PCC - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of secondary (many to one) child layer protocols @@ -826,6 +877,7 @@ def add( Active_pre_established_lsps=None, ConnectedVia=None, ExpectedInitiatedLspsForTraffic=None, + MaxNumberOfMSD=None, Multiplier=None, Name=None, NumberOfBackupPCEs=None, @@ -833,7 +885,7 @@ def add( RequestedLspsPerPcc=None, StackedLayers=None, ): - # type: (int, List[str], int, int, str, int, int, int, List[str]) -> Pcc + # type: (int, List[str], int, int, int, str, int, int, int, List[str]) -> Pcc """Adds a new pcc resource on the server and adds it to the container. Args @@ -841,10 +893,11 @@ def add( - Active_pre_established_lsps (number): - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of layers this layer is used to connect with to the wire. - ExpectedInitiatedLspsForTraffic (number): Based on the value in this control the number of Expected Initiated LSPs for Traffic can be configured. This is used for traffic only. + - MaxNumberOfMSD (number): Maximum number of (MSD-Type ,MSD-Value) pairs that are present in the SRv6-PCE-CAPABILITY sub-TLV. - Multiplier (number): Number of layer instances per parent instance (multiplier) - Name (str): Name of NGPF element, guaranteed to be unique in Scenario - NumberOfBackupPCEs (number): Number of Backup PCEs - - PreEstablishedSrLspsPerPcc (number): Pre-Established SR LSPs per PCC + - PreEstablishedSrLspsPerPcc (number): Pre-Established LSPs per PCC - RequestedLspsPerPcc (number): Requested LSPs per PCC - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of secondary (many to one) child layer protocols @@ -876,6 +929,7 @@ def find( DescriptiveName=None, Errors=None, ExpectedInitiatedLspsForTraffic=None, + MaxNumberOfMSD=None, Multiplier=None, Name=None, NumberOfBackupPCEs=None, @@ -900,10 +954,11 @@ def find( - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. - Errors (list(dict(arg1:str[None | /api/v1/sessions/1/ixnetwork/],arg2:list[str]))): A list of errors that have occurred - ExpectedInitiatedLspsForTraffic (number): Based on the value in this control the number of Expected Initiated LSPs for Traffic can be configured. This is used for traffic only. + - MaxNumberOfMSD (number): Maximum number of (MSD-Type ,MSD-Value) pairs that are present in the SRv6-PCE-CAPABILITY sub-TLV. - Multiplier (number): Number of layer instances per parent instance (multiplier) - Name (str): Name of NGPF element, guaranteed to be unique in Scenario - NumberOfBackupPCEs (number): Number of Backup PCEs - - PreEstablishedSrLspsPerPcc (number): Pre-Established SR LSPs per PCC + - PreEstablishedSrLspsPerPcc (number): Pre-Established LSPs per PCC - RequestedLspsPerPcc (number): Requested LSPs per PCC - SessionStatus (list(str[down | notStarted | up])): Current state of protocol session: Not Started - session negotiation not started, the session is not active yet. Down - actively trying to bring up a protocol session, but negotiation is didn't successfully complete (yet). Up - session came up successfully. - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of secondary (many to one) child layer protocols @@ -1038,7 +1093,7 @@ def GetPccBasicAllSrLspLearnedInfo(self, *args, **kwargs): getPccBasicAllSrLspLearnedInfo(Arg2=list, async_operation=bool)list ------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1080,7 +1135,7 @@ def GetPccBasicAllSrv6LspLearnedInfo(self, *args, **kwargs): getPccBasicAllSrv6LspLearnedInfo(Arg2=list, async_operation=bool)list --------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1122,7 +1177,7 @@ def GetPccBasicSrPccRequestedLspLearnedInfo(self, *args, **kwargs): getPccBasicSrPccRequestedLspLearnedInfo(Arg2=list, async_operation=bool)list ---------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1166,7 +1221,7 @@ def GetPccBasicSrPccSyncOrReportLspLearnedInfo(self, *args, **kwargs): getPccBasicSrPccSyncOrReportLspLearnedInfo(Arg2=list, async_operation=bool)list ------------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1210,7 +1265,7 @@ def GetPccBasicSrPceInitiatedLspLearnedInfo(self, *args, **kwargs): getPccBasicSrPceInitiatedLspLearnedInfo(Arg2=list, async_operation=bool)list ---------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1254,7 +1309,7 @@ def GetPccBasicSrv6PccRequestedLspLearnedInfo(self, *args, **kwargs): getPccBasicSrv6PccRequestedLspLearnedInfo(Arg2=list, async_operation=bool)list ------------------------------------------------------------------------------ - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1298,7 +1353,7 @@ def GetPccBasicSrv6PccSyncOrReportLspLearnedInfo(self, *args, **kwargs): getPccBasicSrv6PccSyncOrReportLspLearnedInfo(Arg2=list, async_operation=bool)list --------------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1342,7 +1397,7 @@ def GetPccBasicSrv6PceInitiatedLspLearnedInfo(self, *args, **kwargs): getPccBasicSrv6PceInitiatedLspLearnedInfo(Arg2=list, async_operation=bool)list ------------------------------------------------------------------------------ - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1426,7 +1481,7 @@ def GetPccSrv6LearnedInfo(self, *args, **kwargs): getPccSrv6LearnedInfo(Arg2=list, async_operation=bool)list ---------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1564,6 +1619,7 @@ def get_device_ids( MaxRequestedLspPerInterval=None, MaxSyncLspPerInterval=None, MaximumSidDepth=None, + NBit=None, PccPpagTLVType=None, PccTEPathBindingTLVType=None, PceIpv4Address=None, @@ -1573,10 +1629,10 @@ def get_device_ids( SrPceCapability=None, Sr_capability_n_flag=None, Sr_capability_x_flag=None, - Srv6MaxSL=None, Srv6PceCapability=None, StateTimeoutInterval=None, TcpPort=None, + XBit=None, ): """Base class infrastructure that gets a list of pcc device ids encapsulated by this object. @@ -1600,6 +1656,7 @@ def get_device_ids( - MaxRequestedLspPerInterval (str): optional regex of maxRequestedLspPerInterval - MaxSyncLspPerInterval (str): optional regex of maxSyncLspPerInterval - MaximumSidDepth (str): optional regex of maximumSidDepth + - NBit (str): optional regex of nBit - PccPpagTLVType (str): optional regex of pccPpagTLVType - PccTEPathBindingTLVType (str): optional regex of pccTEPathBindingTLVType - PceIpv4Address (str): optional regex of pceIpv4Address @@ -1609,10 +1666,10 @@ def get_device_ids( - SrPceCapability (str): optional regex of srPceCapability - Sr_capability_n_flag (str): optional regex of sr_capability_n_flag - Sr_capability_x_flag (str): optional regex of sr_capability_x_flag - - Srv6MaxSL (str): optional regex of srv6MaxSL - Srv6PceCapability (str): optional regex of srv6PceCapability - StateTimeoutInterval (str): optional regex of stateTimeoutInterval - TcpPort (str): optional regex of tcpPort + - XBit (str): optional regex of xBit Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pccgroup_de05278160425f9f4927025725e28501.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pccgroup_de05278160425f9f4927025725e28501.py index e66dc7e55..411b31d89 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pccgroup_de05278160425f9f4927025725e28501.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pccgroup_de05278160425f9f4927025725e28501.py @@ -502,7 +502,7 @@ def PceTEPathBindingTLVType(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): PCE TE-PATH-BINDING TLV Type is a TLV that carries MPLS label binding or SRv6 Binding SID. This is only configurable if the Binding SID Draft Version is set to ietf-pce-binding-label-sid. The minimum value is 0. The maximum value is 65535. The default value is 31. + - obj(ixnetwork_restpy.multivalue.Multivalue): PCE TE-PATH-BINDING TLV Type is a TLV that carries MPLS label binding or SRv6 Binding SID.This is only configurable if the Binding SID Draft Version is set to ietf-pce-binding-label-sid.The minimum value is 0.The maximum value is 65535.The default value is 31. """ from ixnetwork_restpy.multivalue import Multivalue @@ -552,7 +552,7 @@ def Srv6PceCapability(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): The SRv6 PCE Capability TLV is a sub-TLV that comes under PATH-SETUP-TYPE-CAPABILITY TLV if PST List contains SRv6 PST type. This TLV is associated with the OPEN Object to exchange SRv6 capability of PCEP speakers. + - obj(ixnetwork_restpy.multivalue.Multivalue): The SRv6 PCE Capability TLV is a sub-TLV that comes under PATH-SETUP-TYPE-CAPABILITY TLV if PST List contains SRv6 PST type.This TLV is associated with the OPEN Object to exchange SRv6 capability of PCEP speakers. """ from ixnetwork_restpy.multivalue import Multivalue @@ -801,7 +801,7 @@ def ClearPceAllLearnedInfo(self, *args, **kwargs): clearPceAllLearnedInfo(Arg2=list, async_operation=bool)list ----------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -843,7 +843,7 @@ def GetPceBasicAllRsvpLspLearnedInfo(self, *args, **kwargs): getPceBasicAllRsvpLspLearnedInfo(Arg2=list, async_operation=bool)list --------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -885,7 +885,7 @@ def GetPceBasicAllSrLspLearnedInfo(self, *args, **kwargs): getPceBasicAllSrLspLearnedInfo(Arg2=list, async_operation=bool)list ------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -927,7 +927,7 @@ def GetPceBasicAllSrv6LspLearnedInfo(self, *args, **kwargs): getPceBasicAllSrv6LspLearnedInfo(Arg2=list, async_operation=bool)list --------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -969,7 +969,7 @@ def GetPceBasicRsvpPccRequestedLspLearnedInfo(self, *args, **kwargs): getPceBasicRsvpPccRequestedLspLearnedInfo(Arg2=list, async_operation=bool)list ------------------------------------------------------------------------------ - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1013,7 +1013,7 @@ def GetPceBasicRsvpPccSyncLspLearnedInfo(self, *args, **kwargs): getPceBasicRsvpPccSyncLspLearnedInfo(Arg2=list, async_operation=bool)list ------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1057,7 +1057,7 @@ def GetPceBasicRsvpPceInitiatedLspLearnedInfo(self, *args, **kwargs): getPceBasicRsvpPceInitiatedLspLearnedInfo(Arg2=list, async_operation=bool)list ------------------------------------------------------------------------------ - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1101,7 +1101,7 @@ def GetPceBasicSrPccRequestedLspLearnedInfo(self, *args, **kwargs): getPceBasicSrPccRequestedLspLearnedInfo(Arg2=list, async_operation=bool)list ---------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1145,7 +1145,7 @@ def GetPceBasicSrPccSyncLspLearnedInfo(self, *args, **kwargs): getPceBasicSrPccSyncLspLearnedInfo(Arg2=list, async_operation=bool)list ----------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1187,7 +1187,7 @@ def GetPceBasicSrPceInitiatedLspLearnedInfo(self, *args, **kwargs): getPceBasicSrPceInitiatedLspLearnedInfo(Arg2=list, async_operation=bool)list ---------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1231,7 +1231,7 @@ def GetPceBasicSrv6PccRequestedLspLearnedInfo(self, *args, **kwargs): getPceBasicSrv6PccRequestedLspLearnedInfo(Arg2=list, async_operation=bool)list ------------------------------------------------------------------------------ - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1275,7 +1275,7 @@ def GetPceBasicSrv6PccSyncLspLearnedInfo(self, *args, **kwargs): getPceBasicSrv6PccSyncLspLearnedInfo(Arg2=list, async_operation=bool)list ------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1319,7 +1319,7 @@ def GetPceBasicSrv6PceInitiatedLspLearnedInfo(self, *args, **kwargs): getPceBasicSrv6PceInitiatedLspLearnedInfo(Arg2=list, async_operation=bool)list ------------------------------------------------------------------------------ - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1363,7 +1363,7 @@ def GetPceDetailedAllRsvpLspLearnedInfo(self, *args, **kwargs): getPceDetailedAllRsvpLspLearnedInfo(Arg2=list, async_operation=bool)list ------------------------------------------------------------------------ - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1405,7 +1405,7 @@ def GetPceDetailedAllSrLspLearnedInfo(self, *args, **kwargs): getPceDetailedAllSrLspLearnedInfo(Arg2=list, async_operation=bool)list ---------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1447,7 +1447,7 @@ def GetPceDetailedAllSrv6LspLearnedInfo(self, *args, **kwargs): getPceDetailedAllSrv6LspLearnedInfo(Arg2=list, async_operation=bool)list ------------------------------------------------------------------------ - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1489,7 +1489,7 @@ def GetPceDetailedRsvpPccRequestedLspLearnedInfo(self, *args, **kwargs): getPceDetailedRsvpPccRequestedLspLearnedInfo(Arg2=list, async_operation=bool)list --------------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1533,7 +1533,7 @@ def GetPceDetailedRsvpPccSyncLspLearnedInfo(self, *args, **kwargs): getPceDetailedRsvpPccSyncLspLearnedInfo(Arg2=list, async_operation=bool)list ---------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1577,7 +1577,7 @@ def GetPceDetailedRsvpPceInitiatedLspLearnedInfo(self, *args, **kwargs): getPceDetailedRsvpPceInitiatedLspLearnedInfo(Arg2=list, async_operation=bool)list --------------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1621,7 +1621,7 @@ def GetPceDetailedSrPccRequestedLspLearnedInfo(self, *args, **kwargs): getPceDetailedSrPccRequestedLspLearnedInfo(Arg2=list, async_operation=bool)list ------------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1665,7 +1665,7 @@ def GetPceDetailedSrPccSyncLspLearnedInfo(self, *args, **kwargs): getPceDetailedSrPccSyncLspLearnedInfo(Arg2=list, async_operation=bool)list -------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1709,7 +1709,7 @@ def GetPceDetailedSrPceInitiatedLspLearnedInfo(self, *args, **kwargs): getPceDetailedSrPceInitiatedLspLearnedInfo(Arg2=list, async_operation=bool)list ------------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1753,7 +1753,7 @@ def GetPceDetailedSrv6PccRequestedLspLearnedInfo(self, *args, **kwargs): getPceDetailedSrv6PccRequestedLspLearnedInfo(Arg2=list, async_operation=bool)list --------------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1797,7 +1797,7 @@ def GetPceDetailedSrv6PccSyncLspLearnedInfo(self, *args, **kwargs): getPceDetailedSrv6PccSyncLspLearnedInfo(Arg2=list, async_operation=bool)list ---------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation @@ -1841,7 +1841,7 @@ def GetPceDetailedSrv6PceInitiatedLspLearnedInfo(self, *args, **kwargs): getPceDetailedSrv6PceInitiatedLspLearnedInfo(Arg2=list, async_operation=bool)list --------------------------------------------------------------------------------- - - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - Arg2 (list(number)): List of indices into the protocol plugin.An empty list indicates all instances in the plugin. - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. - Returns list(str): ID to associate each async action invocation diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pceinitiatelspparameters_c8b10382dd410ad40974ae280a39117b.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pceinitiatelspparameters_c8b10382dd410ad40974ae280a39117b.py index 9e96a2c01..f1a4ef0b1 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pceinitiatelspparameters_c8b10382dd410ad40974ae280a39117b.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pceinitiatelspparameters_c8b10382dd410ad40974ae280a39117b.py @@ -115,13 +115,13 @@ def PcepEroSubObjectsList(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pceperosubobjectslist_7ea27079d1a1d53cebc6e1e83b2ca0b4.PcepEroSubObjectsList): An instance of the PcepEroSubObjectsList class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pceperosubobjectslist_86d5cc1708b448f03a004b8dddbd83d7.PcepEroSubObjectsList): An instance of the PcepEroSubObjectsList class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pceperosubobjectslist_7ea27079d1a1d53cebc6e1e83b2ca0b4 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pceperosubobjectslist_86d5cc1708b448f03a004b8dddbd83d7 import ( PcepEroSubObjectsList, ) @@ -150,6 +150,26 @@ def PcepMetricSubObjectsList(self): return self._properties.get("PcepMetricSubObjectsList") return PcepMetricSubObjectsList(self) + @property + def PcepSRv6EROObjectsList(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcepsrv6eroobjectslist_205ff487307c7e9626812588ef2b6684.PcepSRv6EROObjectsList): An instance of the PcepSRv6EROObjectsList class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcepsrv6eroobjectslist_205ff487307c7e9626812588ef2b6684 import ( + PcepSRv6EROObjectsList, + ) + + if len(self._object_properties) > 0: + if self._properties.get("PcepSRv6EROObjectsList", None) is not None: + return self._properties.get("PcepSRv6EROObjectsList") + return PcepSRv6EROObjectsList(self) + @property def Active(self): # type: () -> 'Multivalue' @@ -192,7 +212,7 @@ def BindingType(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Indicates the type of binding included in the TLV. Types are as follows: 20bit MPLS Label 32bit MPLS Label SRv6 SID Default value is 20bit MPLS Label. + - obj(ixnetwork_restpy.multivalue.Multivalue): Indicates the type of binding included in the TLV. Types are as follows:20bit MPLS Label32bit MPLS LabelSRv6 SIDDefault value is 20bit MPLS Label. """ from ixnetwork_restpy.multivalue import Multivalue @@ -204,7 +224,7 @@ def Bos(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): This bit is set to True for the last entry in the label stack i.e., for the bottom of the stack, and False for all other label stack entries. This control will be editable only if Binding Type is MPLS Label 32bit. + - obj(ixnetwork_restpy.multivalue.Multivalue): This bit is set to True for the last entry in the label stack i.e., for the bottom of the stack, and False for all other label stack entries.This control will be editable only if Binding Type is MPLS Label 32bit. """ from ixnetwork_restpy.multivalue import Multivalue @@ -366,7 +386,7 @@ def IncludeConfiguredERO(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): If this is enabled, entire ERO will go out in packet even if there is Binding SID, which means no SR-ERO/SRv6-ERO validation will be done. + - obj(ixnetwork_restpy.multivalue.Multivalue): If this is enabled, entire ERO will go out in packet even if there is Binding SID,which means no SR-ERO/SRv6-ERO validation will be done. """ from ixnetwork_restpy.multivalue import Multivalue diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pceperosubobjectslist_7ea27079d1a1d53cebc6e1e83b2ca0b4.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pceperosubobjectslist_86d5cc1708b448f03a004b8dddbd83d7.py similarity index 87% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pceperosubobjectslist_7ea27079d1a1d53cebc6e1e83b2ca0b4.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pceperosubobjectslist_86d5cc1708b448f03a004b8dddbd83d7.py index f73897385..a329e7291 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pceperosubobjectslist_7ea27079d1a1d53cebc6e1e83b2ca0b4.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pceperosubobjectslist_86d5cc1708b448f03a004b8dddbd83d7.py @@ -61,9 +61,6 @@ class PcepEroSubObjectsList(Base): "RemoteNodeId": "remoteNodeId", "Sid": "sid", "SidType": "sidType", - "Srv6FunctionCode": "srv6FunctionCode", - "Srv6Identifier": "srv6Identifier", - "Srv6NaiType": "srv6NaiType", "SubObjectType": "subObjectType", "Tc": "tc", "Ttl": "ttl", @@ -103,7 +100,7 @@ def Bos(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): This bit is set to true for the last entry in the label stack i.e., for the bottom of the stack, and false for all other label stack entries. This control will be editable only if SID Type is MPLS Label 32bit. + - obj(ixnetwork_restpy.multivalue.Multivalue): This bit is set to true for the last entry in the label stack i.e., for the bottom of the stack, and false for all other label stack entries.This control will be editable only if SID Type is MPLS Label 32bit. """ from ixnetwork_restpy.multivalue import Multivalue @@ -195,7 +192,7 @@ def LocalInterfaceId(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): This is the Local Interface ID of the Unnumbered Adjacency with IPv4 NodeIDs which is specified as a pair of Node ID / Interface ID tuples. This Control can be configured if NAI Type is set to Unnumbered Adjacency with IPv4 NodeIDs and F bit is disabled. + - obj(ixnetwork_restpy.multivalue.Multivalue): This is the Local Interface ID of the Unnumbered Adjacency with IPv4 NodeIDs which is specified as a pair of Node ID / Interface ID tuples.This Control can be configured if NAI Type is set to Unnumbered Adjacency with IPv4 NodeIDs and F bit is disabled. """ from ixnetwork_restpy.multivalue import Multivalue @@ -237,7 +234,7 @@ def LocalNodeId(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): This is the Local Node ID of the Unnumbered Adjacency with IPv4 NodeIDs which is specified as a pair of Node ID / Interface ID tuples. This Control can be configured if NAI Type is set to Unnumbered Adjacency with IPv4 NodeIDs and F bit is disabled. + - obj(ixnetwork_restpy.multivalue.Multivalue): This is the Local Node ID of the Unnumbered Adjacency with IPv4 NodeIDs which is specified as a pair of Node ID / Interface ID tuples.This Control can be configured if NAI Type is set to Unnumbered Adjacency with IPv4 NodeIDs and F bit is disabled. """ from ixnetwork_restpy.multivalue import Multivalue @@ -273,7 +270,7 @@ def NaiType(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): NAI (Node or Adjacency Identifier) contains the NAI associated with the SID. Depending on the value of SID Type, the NAI can have different formats such as, Not Applicable IPv4 Node ID IPv6 Node ID IPv4 Adjacency IPv6 Global Adjacency Unnumbered Adjacency with IPv4 NodeIDs IPv6 adjacency with link-local IPv6 addresses + - obj(ixnetwork_restpy.multivalue.Multivalue): NAI (Node or Adjacency Identifier) contains the NAI associated with the SID. Depending on the value of SID Type, the NAI can have different formats such as,Not ApplicableIPv4 Node IDIPv6 Node IDIPv4 AdjacencyIPv6 Global AdjacencyUnnumbered Adjacency with IPv4 NodeIDsIPv6 adjacency with link-local IPv6 addresses """ from ixnetwork_restpy.multivalue import Multivalue @@ -312,7 +309,7 @@ def RemoteInterfaceId(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): This is the Remote Interface ID of the Unnumbered Adjacency with IPv4 NodeIDs which is specified as a pair of Node ID / Interface ID tuples. This Control can be configured if NAI Type is set to Unnumbered Adjacency with IPv4 NodeIDs and F bit is disabled. + - obj(ixnetwork_restpy.multivalue.Multivalue): This is the Remote Interface ID of the Unnumbered Adjacency with IPv4 NodeIDs which is specified as a pair of Node ID / Interface ID tuples.This Control can be configured if NAI Type is set to Unnumbered Adjacency with IPv4 NodeIDs and F bit is disabled. """ from ixnetwork_restpy.multivalue import Multivalue @@ -354,7 +351,7 @@ def RemoteNodeId(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): This is the Remote Node ID of the Unnumbered Adjacency with IPv4 NodeIDs which is specified as a pair of Node ID / Interface ID tuples. This Control can be configured if NAI Type is set to Unnumbered Adjacency with IPv4 NodeIDs and F bit is disabled. + - obj(ixnetwork_restpy.multivalue.Multivalue): This is the Remote Node ID of the Unnumbered Adjacency with IPv4 NodeIDs which is specified as a pair of Node ID / Interface ID tuples.This Control can be configured if NAI Type is set to Unnumbered Adjacency with IPv4 NodeIDs and F bit is disabled. """ from ixnetwork_restpy.multivalue import Multivalue @@ -378,59 +375,19 @@ def SidType(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Using the Segment Identifier Type control user can configure whether to include SID or not and if included what is its type. Types are as follows: Null SID 20bit MPLS Label 32bit MPLS Label. If it is Null then S bit is set in the packet. Default value is 20bit MPLS Label. + - obj(ixnetwork_restpy.multivalue.Multivalue): Using the Segment Identifier Type control user can configure whether to include SID or not and if included what is its type. Types are as follows:NullSID20bit MPLS Label32bit MPLS Label.If it is Null then S bit is set in the packet. Default value is 20bit MPLS Label. """ from ixnetwork_restpy.multivalue import Multivalue return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["SidType"])) - @property - def Srv6FunctionCode(self): - # type: () -> 'Multivalue' - """ - Returns - ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Function Code is is the 16 bit field representing supported functions associated with SRv6 SIDs. This information is optional and included only for maintainability. Following function codes are currently defined - 0: Reserved 1: End Function 2: End.DX6 Function 3: End.DT6 Function 4: End.X Function - """ - from ixnetwork_restpy.multivalue import Multivalue - - return Multivalue( - self, self._get_attribute(self._SDM_ATT_MAP["Srv6FunctionCode"]) - ) - - @property - def Srv6Identifier(self): - # type: () -> 'Multivalue' - """ - Returns - ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): SRv6 Identifier is the 128 bit IPv6 addresses representing SRv6 segment. - """ - from ixnetwork_restpy.multivalue import Multivalue - - return Multivalue( - self, self._get_attribute(self._SDM_ATT_MAP["Srv6Identifier"]) - ) - - @property - def Srv6NaiType(self): - # type: () -> 'Multivalue' - """ - Returns - ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): The SRv6 NAI Type which indicates the interpretation for NAI (Node or Adjacency Identifier). - """ - from ixnetwork_restpy.multivalue import Multivalue - - return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Srv6NaiType"])) - @property def SubObjectType(self): # type: () -> 'Multivalue' """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Using the Sub Object Type control user can configure which sub object needs to be included from the following options: Not Applicable IPv4 Prefix IPv6 Prefix AS Number. + - obj(ixnetwork_restpy.multivalue.Multivalue): Using the Sub Object Type control user can configure which sub object needs to be included from the following options:Not ApplicableIPv4 PrefixIPv6 PrefixAS Number. """ from ixnetwork_restpy.multivalue import Multivalue @@ -562,9 +519,6 @@ def get_device_ids( RemoteNodeId=None, Sid=None, SidType=None, - Srv6FunctionCode=None, - Srv6Identifier=None, - Srv6NaiType=None, SubObjectType=None, Tc=None, Ttl=None, @@ -598,9 +552,6 @@ def get_device_ids( - RemoteNodeId (str): optional regex of remoteNodeId - Sid (str): optional regex of sid - SidType (str): optional regex of sidType - - Srv6FunctionCode (str): optional regex of srv6FunctionCode - - Srv6Identifier (str): optional regex of srv6Identifier - - Srv6NaiType (str): optional regex of srv6NaiType - SubObjectType (str): optional regex of subObjectType - Tc (str): optional regex of tc - Ttl (str): optional regex of ttl diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pcepsrv6eroobjectslist_205ff487307c7e9626812588ef2b6684.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pcepsrv6eroobjectslist_205ff487307c7e9626812588ef2b6684.py new file mode 100644 index 000000000..fb418b318 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pcepsrv6eroobjectslist_205ff487307c7e9626812588ef2b6684.py @@ -0,0 +1,470 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class PcepSRv6EROObjectsList(Base): + """ + The PcepSRv6EROObjectsList class encapsulates a list of pcepSRv6EROObjectsList resources that are managed by the system. + A list of resources can be retrieved from the server using the PcepSRv6EROObjectsList.find() method. + """ + + __slots__ = () + _SDM_NAME = "pcepSRv6EROObjectsList" + _SDM_ATT_MAP = { + "Active": "active", + "Count": "count", + "DescriptiveName": "descriptiveName", + "EndpointBehavior": "endpointBehavior", + "FBit": "fBit", + "Ipv6NodeId": "ipv6NodeId", + "LocalIPv6address": "localIPv6address", + "LocalInterfaceId": "localInterfaceId", + "LocatorBlockLength": "locatorBlockLength", + "LocatorNodeLength": "locatorNodeLength", + "LooseHop": "looseHop", + "Name": "name", + "RemoteIPv6address": "remoteIPv6address", + "RemoteInterfaceId": "remoteInterfaceId", + "SBit": "sBit", + "SidArgumentLength": "sidArgumentLength", + "SidFunctionLength": "sidFunctionLength", + "Srv6Identifier": "srv6Identifier", + "Srv6NaiType": "srv6NaiType", + "TBit": "tBit", + "VBit": "vBit", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(PcepSRv6EROObjectsList, self).__init__(parent, list_op) + + @property + def Active(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Controls whether the ERO sub-object will be sent in the PCEP message. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Active"])) + + @property + def Count(self): + # type: () -> int + """ + Returns + ------- + - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["Count"]) + + @property + def DescriptiveName(self): + # type: () -> str + """ + Returns + ------- + - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + """ + return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) + + @property + def EndpointBehavior(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): A 16 bit field representing the behavior associated with the SRv6 SIDs. This information is optional and plays no role in the fields in SRH imposed on the packet. It could be used for maintainability and diagnostic purpose. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["EndpointBehavior"]) + ) + + @property + def FBit(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): A Flag which is used to carry additional information pertaining to SID. When this bit is set, the NAI value in the subobject body is null. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["FBit"])) + + @property + def Ipv6NodeId(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): IPv6 Node ID is specified as an IPv6 address. This control can be configured if NAI Type is set to IPv6 Node ID and F bit is disabled. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Ipv6NodeId"])) + + @property + def LocalIPv6address(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): This Control can be configured if NAI Type is set to IPv6 Adjacency and F bit is disabled. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["LocalIPv6address"]) + ) + + @property + def LocalInterfaceId(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): This is the Local Interface ID of the IPv6 adjacency with link-local IPv6 addresses which is specified as a pair of Node ID / Interface ID tuples.This Control can be configured if NAI Type is set to IPv6 adjacency with link-local IPv6 addresses and F bit is disabled. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["LocalInterfaceId"]) + ) + + @property + def LocatorBlockLength(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): SRv6 SID Locator Block length in bits. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["LocatorBlockLength"]) + ) + + @property + def LocatorNodeLength(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): SRv6 SID Locator Node length in bits. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["LocatorNodeLength"]) + ) + + @property + def LooseHop(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Indicates if the user wants to represent a loose-hop sub object in the LSP. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["LooseHop"])) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + @property + def RemoteIPv6address(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): This Control can be configured if NAI Type is set to IPv6 Adjacency and F bit is disabled. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["RemoteIPv6address"]) + ) + + @property + def RemoteInterfaceId(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): This is the Remote Interface ID of the IPv6 adjacency with link-local IPv6 addresses which is specified as a pair of Node ID / Interface ID tuples.This Control can be configured if NAI Type is set to IPv6 adjacency with link-local IPv6 addresses and F bit is disabled. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["RemoteInterfaceId"]) + ) + + @property + def SBit(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): A Flag which is used to carry additional information pertaining to SID. When this bit is set, the SRv6 SID value in the subobject body is null. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["SBit"])) + + @property + def SidArgumentLength(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): SRv6 SID Arguments length in bits. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["SidArgumentLength"]) + ) + + @property + def SidFunctionLength(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): SRv6 SID Function length in bits. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["SidFunctionLength"]) + ) + + @property + def Srv6Identifier(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): SRv6 Identifier is the 128 bit IPv6 addresses representing SRv6 segment. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["Srv6Identifier"]) + ) + + @property + def Srv6NaiType(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): The SRv6 NAI Type which indicates the interpretation for NAI (Node or Adjacency Identifier). + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Srv6NaiType"])) + + @property + def TBit(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): This flag is enabled when the SID structure value is present in the subobject body. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["TBit"])) + + @property + def VBit(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Indicates the SID verification bit usage as per section 5.1 of the I-D.ietf-spring-segment-routing-policy. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["VBit"])) + + def update(self, Name=None): + # type: (str) -> PcepSRv6EROObjectsList + """Updates pcepSRv6EROObjectsList resource on the server. + + This method has some named parameters with a type: obj (Multivalue). + The Multivalue class has documentation that details the possible values for those named parameters. + + Args + ---- + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, Name=None): + # type: (str) -> PcepSRv6EROObjectsList + """Adds a new pcepSRv6EROObjectsList resource on the json, only valid with batch add utility + + Args + ---- + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Returns + ------- + - self: This instance with all currently retrieved pcepSRv6EROObjectsList resources using find and the newly added pcepSRv6EROObjectsList resources available through an iterator or index + + Raises + ------ + - Exception: if this function is not being used with config assistance + """ + return self._add_xpath(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Count=None, DescriptiveName=None, Name=None): + # type: (int, str, str) -> PcepSRv6EROObjectsList + """Finds and retrieves pcepSRv6EROObjectsList resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve pcepSRv6EROObjectsList resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all pcepSRv6EROObjectsList resources from the server. + + Args + ---- + - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Returns + ------- + - self: This instance with matching pcepSRv6EROObjectsList resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of pcepSRv6EROObjectsList data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the pcepSRv6EROObjectsList resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) + + def get_device_ids( + self, + PortNames=None, + Active=None, + EndpointBehavior=None, + FBit=None, + Ipv6NodeId=None, + LocalIPv6address=None, + LocalInterfaceId=None, + LocatorBlockLength=None, + LocatorNodeLength=None, + LooseHop=None, + RemoteIPv6address=None, + RemoteInterfaceId=None, + SBit=None, + SidArgumentLength=None, + SidFunctionLength=None, + Srv6Identifier=None, + Srv6NaiType=None, + TBit=None, + VBit=None, + ): + """Base class infrastructure that gets a list of pcepSRv6EROObjectsList device ids encapsulated by this object. + + Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. + + Args + ---- + - PortNames (str): optional regex of port names + - Active (str): optional regex of active + - EndpointBehavior (str): optional regex of endpointBehavior + - FBit (str): optional regex of fBit + - Ipv6NodeId (str): optional regex of ipv6NodeId + - LocalIPv6address (str): optional regex of localIPv6address + - LocalInterfaceId (str): optional regex of localInterfaceId + - LocatorBlockLength (str): optional regex of locatorBlockLength + - LocatorNodeLength (str): optional regex of locatorNodeLength + - LooseHop (str): optional regex of looseHop + - RemoteIPv6address (str): optional regex of remoteIPv6address + - RemoteInterfaceId (str): optional regex of remoteInterfaceId + - SBit (str): optional regex of sBit + - SidArgumentLength (str): optional regex of sidArgumentLength + - SidFunctionLength (str): optional regex of sidFunctionLength + - Srv6Identifier (str): optional regex of srv6Identifier + - Srv6NaiType (str): optional regex of srv6NaiType + - TBit (str): optional regex of tBit + - VBit (str): optional regex of vBit + + Returns + ------- + - list(int): A list of device ids that meets the regex criteria provided in the method parameters + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._get_ngpf_device_ids(locals()) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pcreplylspparameters_73031069954bcd625c2f1df5c90abae7.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pcreplylspparameters_73031069954bcd625c2f1df5c90abae7.py index 2ea3aa4cd..e500eed5c 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pcreplylspparameters_73031069954bcd625c2f1df5c90abae7.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pcreplylspparameters_73031069954bcd625c2f1df5c90abae7.py @@ -115,13 +115,13 @@ def PcepEroSubObjectsList(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pceperosubobjectslist_7ea27079d1a1d53cebc6e1e83b2ca0b4.PcepEroSubObjectsList): An instance of the PcepEroSubObjectsList class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pceperosubobjectslist_86d5cc1708b448f03a004b8dddbd83d7.PcepEroSubObjectsList): An instance of the PcepEroSubObjectsList class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pceperosubobjectslist_7ea27079d1a1d53cebc6e1e83b2ca0b4 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pceperosubobjectslist_86d5cc1708b448f03a004b8dddbd83d7 import ( PcepEroSubObjectsList, ) @@ -150,6 +150,26 @@ def PcepMetricSubObjectsList(self): return self._properties.get("PcepMetricSubObjectsList") return PcepMetricSubObjectsList(self) + @property + def PcepSRv6EROObjectsList(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcepsrv6eroobjectslist_205ff487307c7e9626812588ef2b6684.PcepSRv6EROObjectsList): An instance of the PcepSRv6EROObjectsList class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcepsrv6eroobjectslist_205ff487307c7e9626812588ef2b6684 import ( + PcepSRv6EROObjectsList, + ) + + if len(self._object_properties) > 0: + if self._properties.get("PcepSRv6EROObjectsList", None) is not None: + return self._properties.get("PcepSRv6EROObjectsList") + return PcepSRv6EROObjectsList(self) + @property def Active(self): # type: () -> 'Multivalue' diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pppoxclient_f43b198156c11196dbbd8c4dbee2af9d.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pppoxclient_f43b198156c11196dbbd8c4dbee2af9d.py index e00cfeaa9..13d1ed6e3 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pppoxclient_f43b198156c11196dbbd8c4dbee2af9d.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pppoxclient_f43b198156c11196dbbd8c4dbee2af9d.py @@ -248,13 +248,13 @@ def BgpIpv6Peer(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_d1a9d481647a51c783f6ad2bd104f872.BgpIpv6Peer): An instance of the BgpIpv6Peer class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_cc4b2c56b540aa17ec1d2d616e50cd4b.BgpIpv6Peer): An instance of the BgpIpv6Peer class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_d1a9d481647a51c783f6ad2bd104f872 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_cc4b2c56b540aa17ec1d2d616e50cd4b import ( BgpIpv6Peer, ) @@ -548,13 +548,13 @@ def Pcc(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_4548de1a5046938dd4962870dfbd425f.Pcc): An instance of the Pcc class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_80e0369b498001415dc4db6533e36cc5.Pcc): An instance of the Pcc class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_4548de1a5046938dd4962870dfbd425f import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_80e0369b498001415dc4db6533e36cc5 import ( Pcc, ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pppoxserver_622ad1c6d961bb8e246b079c72242bfa.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pppoxserver_622ad1c6d961bb8e246b079c72242bfa.py index 35a649634..c975b7535 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pppoxserver_622ad1c6d961bb8e246b079c72242bfa.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/pppoxserver_622ad1c6d961bb8e246b079c72242bfa.py @@ -213,13 +213,13 @@ def BgpIpv6Peer(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_d1a9d481647a51c783f6ad2bd104f872.BgpIpv6Peer): An instance of the BgpIpv6Peer class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_cc4b2c56b540aa17ec1d2d616e50cd4b.BgpIpv6Peer): An instance of the BgpIpv6Peer class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_d1a9d481647a51c783f6ad2bd104f872 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.bgpipv6peer_cc4b2c56b540aa17ec1d2d616e50cd4b import ( BgpIpv6Peer, ) @@ -513,13 +513,13 @@ def Pcc(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_4548de1a5046938dd4962870dfbd425f.Pcc): An instance of the Pcc class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_80e0369b498001415dc4db6533e36cc5.Pcc): An instance of the Pcc class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_4548de1a5046938dd4962870dfbd425f import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcc_80e0369b498001415dc4db6533e36cc5 import ( Pcc, ) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/preestablishedsrlsps_a4b5c388b0a9f1cd18fdc396c2ea1c6a.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/preestablishedsrlsps_c620eef5df7101b5105821449dec19dc.py similarity index 94% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/preestablishedsrlsps_a4b5c388b0a9f1cd18fdc396c2ea1c6a.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/preestablishedsrlsps_c620eef5df7101b5105821449dec19dc.py index 6e571dd40..1d4f7cafb 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/preestablishedsrlsps_a4b5c388b0a9f1cd18fdc396c2ea1c6a.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/preestablishedsrlsps_c620eef5df7101b5105821449dec19dc.py @@ -67,6 +67,7 @@ class PreEstablishedSrLsps(Base): "NumberOfEroSubObjects": "numberOfEroSubObjects", "NumberOfMetricSubObject": "numberOfMetricSubObject", "OverridePlspId": "overridePlspId", + "PathSetupType": "pathSetupType", "PlspId": "plspId", "ProtectionLspBit": "protectionLspBit", "ReDelegationTimerStatus": "reDelegationTimerStatus", @@ -80,7 +81,9 @@ class PreEstablishedSrLsps(Base): "Tc": "tc", "Ttl": "ttl", } - _SDM_ENUM_MAP = {} + _SDM_ENUM_MAP = { + "pathSetupType": ["sR", "sRv6"], + } def __init__(self, parent, list_op=False): super(PreEstablishedSrLsps, self).__init__(parent, list_op) @@ -90,13 +93,13 @@ def PcepEroSubObjectsList(self): """ Returns ------- - - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pceperosubobjectslist_7ea27079d1a1d53cebc6e1e83b2ca0b4.PcepEroSubObjectsList): An instance of the PcepEroSubObjectsList class + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pceperosubobjectslist_86d5cc1708b448f03a004b8dddbd83d7.PcepEroSubObjectsList): An instance of the PcepEroSubObjectsList class Raises ------ - ServerError: The server has encountered an uncategorized error condition """ - from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pceperosubobjectslist_7ea27079d1a1d53cebc6e1e83b2ca0b4 import ( + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pceperosubobjectslist_86d5cc1708b448f03a004b8dddbd83d7 import ( PcepEroSubObjectsList, ) @@ -125,6 +128,26 @@ def PcepMetricSubObjectsList(self): return self._properties.get("PcepMetricSubObjectsList") return PcepMetricSubObjectsList(self) + @property + def PcepSRv6EROObjectsList(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcepsrv6eroobjectslist_205ff487307c7e9626812588ef2b6684.PcepSRv6EROObjectsList): An instance of the PcepSRv6EROObjectsList class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.pcepsrv6eroobjectslist_205ff487307c7e9626812588ef2b6684 import ( + PcepSRv6EROObjectsList, + ) + + if len(self._object_properties) > 0: + if self._properties.get("PcepSRv6EROObjectsList", None) is not None: + return self._properties.get("PcepSRv6EROObjectsList") + return PcepSRv6EROObjectsList(self) + @property def Tag(self): """ @@ -556,6 +579,21 @@ def OverridePlspId(self, value): # type: (bool) -> None self._set_attribute(self._SDM_ATT_MAP["OverridePlspId"], value) + @property + def PathSetupType(self): + # type: () -> str + """ + Returns + ------- + - str(sR | sRv6): Indicates the type of LSP that will be sent in the PcReport for Pre-Established LSPs. + """ + return self._get_attribute(self._SDM_ATT_MAP["PathSetupType"]) + + @PathSetupType.setter + def PathSetupType(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["PathSetupType"], value) + @property def PlspId(self): # type: () -> 'Multivalue' @@ -715,8 +753,9 @@ def update( NumberOfEroSubObjects=None, NumberOfMetricSubObject=None, OverridePlspId=None, + PathSetupType=None, ): - # type: (bool, str, int, int, bool) -> PreEstablishedSrLsps + # type: (bool, str, int, int, bool, str) -> PreEstablishedSrLsps """Updates preEstablishedSrLsps resource on the server. This method has some named parameters with a type: obj (Multivalue). @@ -729,6 +768,7 @@ def update( - NumberOfEroSubObjects (number): Value that indicates the number of ERO Sub Objects to be configured. - NumberOfMetricSubObject (number): Value that indicates the number of Metric Objects to be configured. - OverridePlspId (bool): Indicates if PLSP-ID will be set by the state machine or user. If disabled user wont have the control and state machine will set it. + - PathSetupType (str(sR | sRv6)): Indicates the type of LSP that will be sent in the PcReport for Pre-Established LSPs. Raises ------ @@ -746,9 +786,10 @@ def find( NumberOfEroSubObjects=None, NumberOfMetricSubObject=None, OverridePlspId=None, + PathSetupType=None, ReDelegationTimerStatus=None, ): - # type: (int, str, bool, List[str], str, int, int, bool, List[str]) -> PreEstablishedSrLsps + # type: (int, str, bool, List[str], str, int, int, bool, str, List[str]) -> PreEstablishedSrLsps """Finds and retrieves preEstablishedSrLsps resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve preEstablishedSrLsps resources from the server. @@ -765,6 +806,7 @@ def find( - NumberOfEroSubObjects (number): Value that indicates the number of ERO Sub Objects to be configured. - NumberOfMetricSubObject (number): Value that indicates the number of Metric Objects to be configured. - OverridePlspId (bool): Indicates if PLSP-ID will be set by the state machine or user. If disabled user wont have the control and state machine will set it. + - PathSetupType (str(sR | sRv6)): Indicates the type of LSP that will be sent in the PcReport for Pre-Established LSPs. - ReDelegationTimerStatus (list(str[expired | none | notStarted | running | stopped])): Re-Delegation Timer Status Returns diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ptp_24f2907f5a685b611f57469838b21337.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ptp_10b9c21d9c7cf77e86ec2d87b28de348.py similarity index 99% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ptp_24f2907f5a685b611f57469838b21337.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ptp_10b9c21d9c7cf77e86ec2d87b28de348.py index d0ac3f93d..9e3076c83 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ptp_24f2907f5a685b611f57469838b21337.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ptp_10b9c21d9c7cf77e86ec2d87b28de348.py @@ -162,6 +162,7 @@ class Ptp(Base): "RequestInterval": "requestInterval", "Reserved": "reserved", "ReverseSync": "reverseSync", + "ReverseSyncDomain": "reverseSyncDomain", "ReverseSyncIntervalPercent": "reverseSyncIntervalPercent", "Role": "role", "RxCalibration": "rxCalibration", @@ -1980,6 +1981,20 @@ def ReverseSync(self): return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["ReverseSync"])) + @property + def ReverseSyncDomain(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): As a slave will use this 'Reverse Sync Domain' to send reverse sync messages. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["ReverseSyncDomain"]) + ) + @property def ReverseSyncIntervalPercent(self): # type: () -> 'Multivalue' @@ -3145,6 +3160,7 @@ def get_device_ids( RequestInterval=None, Reserved=None, ReverseSync=None, + ReverseSyncDomain=None, ReverseSyncIntervalPercent=None, Role=None, RxCalibration=None, @@ -3298,6 +3314,7 @@ def get_device_ids( - RequestInterval (str): optional regex of requestInterval - Reserved (str): optional regex of reserved - ReverseSync (str): optional regex of reverseSync + - ReverseSyncDomain (str): optional regex of reverseSyncDomain - ReverseSyncIntervalPercent (str): optional regex of reverseSyncIntervalPercent - Role (str): optional regex of role - RxCalibration (str): optional regex of rxCalibration diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/rucarrier_9fc1ca05aa71639ef4aa1bf05267ec32.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/rucarrier_9fc1ca05aa71639ef4aa1bf05267ec32.py index 3657dd5eb..41752c262 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/rucarrier_9fc1ca05aa71639ef4aa1bf05267ec32.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/rucarrier_9fc1ca05aa71639ef4aa1bf05267ec32.py @@ -88,7 +88,7 @@ def BandSectorId(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Band Sector ID. + - obj(ixnetwork_restpy.multivalue.Multivalue): Aggregated Cell identifier which distinguishes bands and sectors supported by O-RU. """ from ixnetwork_restpy.multivalue import Multivalue @@ -112,7 +112,7 @@ def CcId(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): CC ID. + - obj(ixnetwork_restpy.multivalue.Multivalue): CC(Component Carrier) identifier which distinguishes carrier components supported by O-RU. """ from ixnetwork_restpy.multivalue import Multivalue @@ -144,7 +144,7 @@ def DuPortId(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): DU Port ID. + - obj(ixnetwork_restpy.multivalue.Multivalue): DU(Distributed Unit)identifier used to differentiate processing units at DU. """ from ixnetwork_restpy.multivalue import Multivalue @@ -156,7 +156,7 @@ def IqBitwidth(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Depends on the selected compression mthod No compression - represents the bitwidth of each uncompressed I and Q value. Block floating point - represents the bitwidth of each I and Q mantissa value. + - obj(ixnetwork_restpy.multivalue.Multivalue): Depends on the selected compression method. No compression: Represents the bitwidth of each uncompressed I and Q value. Block floating point: Represents the bitwidth of each I and Q mantissa value. """ from ixnetwork_restpy.multivalue import Multivalue @@ -168,7 +168,7 @@ def IqCompMethod(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): IQ Compression Method. + - obj(ixnetwork_restpy.multivalue.Multivalue): Indicates the compression algorithm used for the IQ samples. """ from ixnetwork_restpy.multivalue import Multivalue @@ -195,7 +195,7 @@ def Numerology(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Number which is used in the formula to calculate sub-carrier spacing. + - obj(ixnetwork_restpy.multivalue.Multivalue): Numerology indicates the sub-carrier spacing. """ from ixnetwork_restpy.multivalue import Multivalue @@ -207,7 +207,7 @@ def PrbCount(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Number of PRBs(Physical Resource Blocks). + - obj(ixnetwork_restpy.multivalue.Multivalue): Number of PRBs(Physical Resource Blocks) for a symbol. """ from ixnetwork_restpy.multivalue import Multivalue @@ -219,7 +219,7 @@ def RuPortId(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): RU Port ID. + - obj(ixnetwork_restpy.multivalue.Multivalue): RU(Radio Unit) identifier which designates logical flows. """ from ixnetwork_restpy.multivalue import Multivalue @@ -231,7 +231,7 @@ def SlotFormat(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Configuration of the slot. + - obj(ixnetwork_restpy.multivalue.Multivalue): Configuration of the slot which has 14 symbols. """ from ixnetwork_restpy.multivalue import Multivalue @@ -243,7 +243,7 @@ def Symbol0(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 0 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 0 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -255,7 +255,7 @@ def Symbol1(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 1 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 1 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -267,7 +267,7 @@ def Symbol10(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 10 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 10 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -279,7 +279,7 @@ def Symbol11(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 11 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 11 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -291,7 +291,7 @@ def Symbol12(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 12 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 12 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -303,7 +303,7 @@ def Symbol13(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 13 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 13 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -315,7 +315,7 @@ def Symbol2(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 2 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 2 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -327,7 +327,7 @@ def Symbol3(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 3 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 3 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -339,7 +339,7 @@ def Symbol4(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 4 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 4 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -351,7 +351,7 @@ def Symbol5(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 5 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 5 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -363,7 +363,7 @@ def Symbol6(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 6 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 6 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -375,7 +375,7 @@ def Symbol7(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 7 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 7 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -387,7 +387,7 @@ def Symbol8(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 8 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 8 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -399,7 +399,7 @@ def Symbol9(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 9 of carrier. + - obj(ixnetwork_restpy.multivalue.Multivalue): Symbol 9 of slot. """ from ixnetwork_restpy.multivalue import Multivalue @@ -411,7 +411,7 @@ def UdCompHeaderInUPlane(self): """ Returns ------- - - obj(ixnetwork_restpy.multivalue.Multivalue): udCompHeader in U-plane + - obj(ixnetwork_restpy.multivalue.Multivalue): Include udCompHdr value in the U-plane message. """ from ixnetwork_restpy.multivalue import Multivalue diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/rucuplane_5a30497b19e2a66b22c8822c83c1df83.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/rucuplane_5a30497b19e2a66b22c8822c83c1df83.py index 2c98bec30..662857c95 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/rucuplane_5a30497b19e2a66b22c8822c83c1df83.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/rucuplane_5a30497b19e2a66b22c8822c83c1df83.py @@ -28,7 +28,7 @@ class RuCUPlane(Base): - """ORAN RU CU-Plane for traffic destination endpoint. + """ORAN RU CU-Plane represents the destination endpoint in traffic wizard which is used for both control and user data messages. The RuCUPlane class encapsulates a required ruCUPlane resource which will be retrieved from the server every time the property is accessed. """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ruuplane_49d312b91abfe9fd6bdfee21a53fb842.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ruuplane_49d312b91abfe9fd6bdfee21a53fb842.py index 2ff4d4cb8..a2db8082c 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ruuplane_49d312b91abfe9fd6bdfee21a53fb842.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/ruuplane_49d312b91abfe9fd6bdfee21a53fb842.py @@ -28,7 +28,7 @@ class RuUPlane(Base): - """ORAN RU U Plane for traffic wizard. + """ORAN RU U Plane represents the source endpoint used in traffic wizard which is used to configure user data message. The RuUPlane class encapsulates a required ruUPlane resource which will be retrieved from the server every time the property is accessed. """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/staticmacsec_334bb16ed0f82339d219d0d5f058cee4.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/staticmacsec_b2bfb1c8c259661514373bf3afb4450d.py similarity index 99% rename from ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/staticmacsec_334bb16ed0f82339d219d0d5f058cee4.py rename to ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/staticmacsec_b2bfb1c8c259661514373bf3afb4450d.py index 1674c4c82..fb947ab81 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/staticmacsec_334bb16ed0f82339d219d0d5f058cee4.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/staticmacsec_b2bfb1c8c259661514373bf3afb4450d.py @@ -56,6 +56,7 @@ class StaticMacsec(Base): "EncryptionEngine": "encryptionEngine", "EndStation": "endStation", "Errors": "errors", + "ExcludedProtocols": "excludedProtocols", "FixedPn": "fixedPn", "IncludeSci": "includeSci", "Multiplier": "multiplier", @@ -467,6 +468,20 @@ def Errors(self): """ return self._get_attribute(self._SDM_ATT_MAP["Errors"]) + @property + def ExcludedProtocols(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Excluded Protocol + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["ExcludedProtocols"]) + ) + @property def FixedPn(self): # type: () -> int @@ -1176,6 +1191,7 @@ def get_device_ids( EnableEncryptedVlan=None, EnableEncryptedVlans=None, EndStation=None, + ExcludedProtocols=None, IncludeSci=None, MvFixedXpn=None, OverrideTciSetting=None, @@ -1209,6 +1225,7 @@ def get_device_ids( - EnableEncryptedVlan (str): optional regex of enableEncryptedVlan - EnableEncryptedVlans (str): optional regex of enableEncryptedVlans - EndStation (str): optional regex of endStation + - ExcludedProtocols (str): optional regex of excludedProtocols - IncludeSci (str): optional regex of includeSci - MvFixedXpn (str): optional regex of mvFixedXpn - OverrideTciSetting (str): optional regex of overrideTciSetting diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/twampipv4_f2b0095d1b19a5361901666837fd27ba.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/twampipv4_f2b0095d1b19a5361901666837fd27ba.py new file mode 100644 index 000000000..c34ee0b5a --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/twampipv4_f2b0095d1b19a5361901666837fd27ba.py @@ -0,0 +1,818 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class TwampIpv4(Base): + """Twamp IPv4 Session + The TwampIpv4 class encapsulates a list of twampIpv4 resources that are managed by the user. + A list of resources can be retrieved from the server using the TwampIpv4.find() method. + The list can be managed by using the TwampIpv4.add() and TwampIpv4.remove() methods. + """ + + __slots__ = () + _SDM_NAME = "twampIpv4" + _SDM_ATT_MAP = { + "Active": "active", + "AuthType": "authType", + "ConnectedVia": "connectedVia", + "Count": "count", + "DescriptiveName": "descriptiveName", + "EnableSSID": "enableSSID", + "Errors": "errors", + "HostMode": "hostMode", + "MeasurementType": "measurementType", + "Multiplier": "multiplier", + "Name": "name", + "NoOfDest": "noOfDest", + "NoOfPackets": "noOfPackets", + "PacketLength": "packetLength", + "PacketsPerSecond": "packetsPerSecond", + "PaddingWithZero": "paddingWithZero", + "ReflectorPort": "reflectorPort", + "Scale": "scale", + "SenderPort": "senderPort", + "SessionStatus": "sessionStatus", + "Sflag": "sflag", + "SrMode": "srMode", + "StackedLayers": "stackedLayers", + "StateCounts": "stateCounts", + "StateType": "stateType", + "StatsInterval": "statsInterval", + "StatsUpdateMode": "statsUpdateMode", + "Status": "status", + "Timeout": "timeout", + "TwampMode": "twampMode", + "Zflag": "zflag", + } + _SDM_ENUM_MAP = { + "status": [ + "configured", + "error", + "mixed", + "notStarted", + "started", + "starting", + "stopping", + ], + } + + def __init__(self, parent, list_op=False): + super(TwampIpv4, self).__init__(parent, list_op) + + @property + def TwampIpv4DstList(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.twampipv4dstlist_71a0edca2f4ac671c689f9a13c1374b6.TwampIpv4DstList): An instance of the TwampIpv4DstList class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.twampipv4dstlist_71a0edca2f4ac671c689f9a13c1374b6 import ( + TwampIpv4DstList, + ) + + if len(self._object_properties) > 0: + if self._properties.get("TwampIpv4DstList", None) is not None: + return self._properties.get("TwampIpv4DstList") + return TwampIpv4DstList(self)._select() + + @property + def Active(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Activate/Deactivate Configuration + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Active"])) + + @property + def AuthType(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the authentication mode of the host. Options are: Authenticated, UnAuthenticated. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["AuthType"])) + + @property + def ConnectedVia(self): + # type: () -> List[str] + """DEPRECATED + Returns + ------- + - list(str[None | /api/v1/sessions/1/ixnetwork/topology]): List of layers this layer is used to connect with to the wire. + """ + return self._get_attribute(self._SDM_ATT_MAP["ConnectedVia"]) + + @ConnectedVia.setter + def ConnectedVia(self, value): + # type: (List[str]) -> None + self._set_attribute(self._SDM_ATT_MAP["ConnectedVia"], value) + + @property + def Count(self): + # type: () -> int + """ + Returns + ------- + - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["Count"]) + + @property + def DescriptiveName(self): + # type: () -> str + """ + Returns + ------- + - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + """ + return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) + + @property + def EnableSSID(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Enable this option to Auto Configure the SSID when it is in the STAMP mode. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["EnableSSID"])) + + @property + def Errors(self): + """ + Returns + ------- + - list(dict(arg1:str[None | /api/v1/sessions/1/ixnetwork/],arg2:list[str])): A list of errors that have occurred + """ + return self._get_attribute(self._SDM_ATT_MAP["Errors"]) + + @property + def HostMode(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the mode in which the host should be running. Options are: Sender, Reflector. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["HostMode"])) + + @property + def MeasurementType(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the Measurement type of the host. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["MeasurementType"]) + ) + + @property + def Multiplier(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Multiplier is used for calculating error estimation. Error estimate = Multiplier*2^(-32)*2^Scale (in seconds). + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Multiplier"])) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + @property + def NoOfDest(self): + # type: () -> int + """ + Returns + ------- + - number: Specify the number of destinations to which the requests have to be sent. + """ + return self._get_attribute(self._SDM_ATT_MAP["NoOfDest"]) + + @NoOfDest.setter + def NoOfDest(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["NoOfDest"], value) + + @property + def NoOfPackets(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the Total number of test packets to be sent. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["NoOfPackets"])) + + @property + def PacketLength(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the total length of the packet with padding. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["PacketLength"])) + + @property + def PacketsPerSecond(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the rate at which packets should be sent per second. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["PacketsPerSecond"]) + ) + + @property + def PaddingWithZero(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Enable this option if Padding should be filled with Zero. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["PaddingWithZero"]) + ) + + @property + def ReflectorPort(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the starting UDP port. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["ReflectorPort"])) + + @property + def Scale(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Scale is used for calculating error estimation. Error estimate = Multiplier*2^(-32)*2^Scale (in seconds). + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Scale"])) + + @property + def SenderPort(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the starting UDP port. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["SenderPort"])) + + @property + def SessionStatus(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str[down | notStarted | up]): Current state of protocol session: Not Started - session negotiation not started, the session is not active yet. Down - actively trying to bring up a protocol session, but negotiation is didn't successfully complete (yet). Up - session came up successfully. + """ + return self._get_attribute(self._SDM_ATT_MAP["SessionStatus"]) + + @property + def Sflag(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Select this option if clock is synchronized to UTC using an external source. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Sflag"])) + + @property + def SrMode(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the Segment Routing Mode to be supported. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["SrMode"])) + + @property + def StackedLayers(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str[None | /api/v1/sessions/1/ixnetwork/topology]): List of secondary (many to one) child layer protocols + """ + return self._get_attribute(self._SDM_ATT_MAP["StackedLayers"]) + + @StackedLayers.setter + def StackedLayers(self, value): + # type: (List[str]) -> None + self._set_attribute(self._SDM_ATT_MAP["StackedLayers"], value) + + @property + def StateCounts(self): + """ + Returns + ------- + - dict(total:number,notStarted:number,down:number,up:number): A list of values that indicates the total number of sessions, the number of sessions not started, the number of sessions down and the number of sessions that are up + """ + return self._get_attribute(self._SDM_ATT_MAP["StateCounts"]) + + @property + def StateType(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the operation mode of the host. Options are: Statefull, Stateless. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["StateType"])) + + @property + def StatsInterval(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): This specifies the Interval at which Stats has to be updated periodically. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["StatsInterval"])) + + @property + def StatsUpdateMode(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the mode using which Stats needs to be updated. Continuous - All Stats will be updated perdiocally as per specified Stats Interval. ManualAction - Only Basic Tx, Rx, Loss, stats are updated every 2 sec, all other stats will be updated whenever Manual Action is triggered or test is completed. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["StatsUpdateMode"]) + ) + + @property + def Status(self): + # type: () -> str + """ + Returns + ------- + - str(configured | error | mixed | notStarted | started | starting | stopping): Running status of associated network element. Once in Started state, protocol sessions will begin to negotiate. + """ + return self._get_attribute(self._SDM_ATT_MAP["Status"]) + + @property + def Timeout(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the Timeout of Session Sender. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Timeout"])) + + @property + def TwampMode(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the specific RFC that should be run by this Twamp device. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["TwampMode"])) + + @property + def Zflag(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Select this Option to indicate to the format of a collected timestamp. If disabled - NTP 64 bit format. If enabled - PTPv2-truncated format. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Zflag"])) + + def update(self, ConnectedVia=None, Name=None, NoOfDest=None, StackedLayers=None): + # type: (List[str], str, int, List[str]) -> TwampIpv4 + """Updates twampIpv4 resource on the server. + + This method has some named parameters with a type: obj (Multivalue). + The Multivalue class has documentation that details the possible values for those named parameters. + + Args + ---- + - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of layers this layer is used to connect with to the wire. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - NoOfDest (number): Specify the number of destinations to which the requests have to be sent. + - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of secondary (many to one) child layer protocols + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, ConnectedVia=None, Name=None, NoOfDest=None, StackedLayers=None): + # type: (List[str], str, int, List[str]) -> TwampIpv4 + """Adds a new twampIpv4 resource on the server and adds it to the container. + + Args + ---- + - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of layers this layer is used to connect with to the wire. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - NoOfDest (number): Specify the number of destinations to which the requests have to be sent. + - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of secondary (many to one) child layer protocols + + Returns + ------- + - self: This instance with all currently retrieved twampIpv4 resources using find and the newly added twampIpv4 resources available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._create(self._map_locals(self._SDM_ATT_MAP, locals())) + + def remove(self): + """Deletes all the contained twampIpv4 resources in this instance from the server. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + self._delete() + + def find( + self, + ConnectedVia=None, + Count=None, + DescriptiveName=None, + Errors=None, + Name=None, + NoOfDest=None, + SessionStatus=None, + StackedLayers=None, + StateCounts=None, + Status=None, + ): + """Finds and retrieves twampIpv4 resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve twampIpv4 resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all twampIpv4 resources from the server. + + Args + ---- + - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of layers this layer is used to connect with to the wire. + - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + - Errors (list(dict(arg1:str[None | /api/v1/sessions/1/ixnetwork/],arg2:list[str]))): A list of errors that have occurred + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - NoOfDest (number): Specify the number of destinations to which the requests have to be sent. + - SessionStatus (list(str[down | notStarted | up])): Current state of protocol session: Not Started - session negotiation not started, the session is not active yet. Down - actively trying to bring up a protocol session, but negotiation is didn't successfully complete (yet). Up - session came up successfully. + - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of secondary (many to one) child layer protocols + - StateCounts (dict(total:number,notStarted:number,down:number,up:number)): A list of values that indicates the total number of sessions, the number of sessions not started, the number of sessions down and the number of sessions that are up + - Status (str(configured | error | mixed | notStarted | started | starting | stopping)): Running status of associated network element. Once in Started state, protocol sessions will begin to negotiate. + + Returns + ------- + - self: This instance with matching twampIpv4 resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of twampIpv4 data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the twampIpv4 resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) + + def Abort(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the abort operation on the server. + + Abort CPF control plane (equals to demote to kUnconfigured state). + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + abort(async_operation=bool) + --------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + abort(SessionIndices=list, async_operation=bool) + ------------------------------------------------ + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + abort(SessionIndices=string, async_operation=bool) + -------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("abort", payload=payload, response_object=None) + + def GetStatistics(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the getStatistics operation on the server. + + Sends a Statistics Request message. + + getStatistics(Arg2=list, async_operation=bool)list + -------------------------------------------------- + - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self.href} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("getStatistics", payload=payload, response_object=None) + + def RestartDown(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the restartDown operation on the server. + + Stop and start interfaces and sessions that are in Down state. + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + restartDown(async_operation=bool) + --------------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + restartDown(SessionIndices=list, async_operation=bool) + ------------------------------------------------------ + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + restartDown(SessionIndices=string, async_operation=bool) + -------------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("restartDown", payload=payload, response_object=None) + + def Start(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the start operation on the server. + + Start CPF control plane (equals to promote to negotiated state). + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + start(async_operation=bool) + --------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + start(SessionIndices=list, async_operation=bool) + ------------------------------------------------ + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + start(SessionIndices=string, async_operation=bool) + -------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("start", payload=payload, response_object=None) + + def Stop(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the stop operation on the server. + + Stop CPF control plane (equals to demote to PreValidated-DoDDone state). + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + stop(async_operation=bool) + -------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + stop(SessionIndices=list, async_operation=bool) + ----------------------------------------------- + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + stop(SessionIndices=string, async_operation=bool) + ------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("stop", payload=payload, response_object=None) + + def get_device_ids( + self, + PortNames=None, + Active=None, + AuthType=None, + EnableSSID=None, + HostMode=None, + MeasurementType=None, + Multiplier=None, + NoOfPackets=None, + PacketLength=None, + PacketsPerSecond=None, + PaddingWithZero=None, + ReflectorPort=None, + Scale=None, + SenderPort=None, + Sflag=None, + SrMode=None, + StateType=None, + StatsInterval=None, + StatsUpdateMode=None, + Timeout=None, + TwampMode=None, + Zflag=None, + ): + """Base class infrastructure that gets a list of twampIpv4 device ids encapsulated by this object. + + Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. + + Args + ---- + - PortNames (str): optional regex of port names + - Active (str): optional regex of active + - AuthType (str): optional regex of authType + - EnableSSID (str): optional regex of enableSSID + - HostMode (str): optional regex of hostMode + - MeasurementType (str): optional regex of measurementType + - Multiplier (str): optional regex of multiplier + - NoOfPackets (str): optional regex of noOfPackets + - PacketLength (str): optional regex of packetLength + - PacketsPerSecond (str): optional regex of packetsPerSecond + - PaddingWithZero (str): optional regex of paddingWithZero + - ReflectorPort (str): optional regex of reflectorPort + - Scale (str): optional regex of scale + - SenderPort (str): optional regex of senderPort + - Sflag (str): optional regex of sflag + - SrMode (str): optional regex of srMode + - StateType (str): optional regex of stateType + - StatsInterval (str): optional regex of statsInterval + - StatsUpdateMode (str): optional regex of statsUpdateMode + - Timeout (str): optional regex of timeout + - TwampMode (str): optional regex of twampMode + - Zflag (str): optional regex of zflag + + Returns + ------- + - list(int): A list of device ids that meets the regex criteria provided in the method parameters + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._get_ngpf_device_ids(locals()) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/twampipv4dstlist_71a0edca2f4ac671c689f9a13c1374b6.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/twampipv4dstlist_71a0edca2f4ac671c689f9a13c1374b6.py new file mode 100644 index 000000000..80f6f606f --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/twampipv4dstlist_71a0edca2f4ac671c689f9a13c1374b6.py @@ -0,0 +1,252 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class TwampIpv4DstList(Base): + """Twamp IPv4 Destinations + The TwampIpv4DstList class encapsulates a required twampIpv4DstList resource which will be retrieved from the server every time the property is accessed. + """ + + __slots__ = () + _SDM_NAME = "twampIpv4DstList" + _SDM_ATT_MAP = { + "Active": "active", + "Count": "count", + "DescriptiveName": "descriptiveName", + "DestPort": "destPort", + "Ipv4DestAddress": "ipv4DestAddress", + "Name": "name", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(TwampIpv4DstList, self).__init__(parent, list_op) + + @property + def Active(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Activate/Deactivate Configuration. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Active"])) + + @property + def Count(self): + # type: () -> int + """ + Returns + ------- + - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["Count"]) + + @property + def DescriptiveName(self): + # type: () -> str + """ + Returns + ------- + - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + """ + return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) + + @property + def DestPort(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the destination port to which request has to be sent. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["DestPort"])) + + @property + def Ipv4DestAddress(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the IPv4 destination address to which request has to be sent. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["Ipv4DestAddress"]) + ) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + def update(self, Name=None): + # type: (str) -> TwampIpv4DstList + """Updates twampIpv4DstList resource on the server. + + This method has some named parameters with a type: obj (Multivalue). + The Multivalue class has documentation that details the possible values for those named parameters. + + Args + ---- + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Count=None, DescriptiveName=None, Name=None): + # type: (int, str, str) -> TwampIpv4DstList + """Finds and retrieves twampIpv4DstList resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve twampIpv4DstList resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all twampIpv4DstList resources from the server. + + Args + ---- + - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Returns + ------- + - self: This instance with matching twampIpv4DstList resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of twampIpv4DstList data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the twampIpv4DstList resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) + + def SendTwampRequest(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the sendTwampRequest operation on the server. + + Sends a Twamp Request message. + + sendTwampRequest(Arg2=list, async_operation=bool)list + ----------------------------------------------------- + - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self.href} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("sendTwampRequest", payload=payload, response_object=None) + + def StopTwampRequest(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the stopTwampRequest operation on the server. + + Sends a Twamp Stop Request message. + + stopTwampRequest(Arg2=list, async_operation=bool)list + ----------------------------------------------------- + - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self.href} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("stopTwampRequest", payload=payload, response_object=None) + + def get_device_ids( + self, PortNames=None, Active=None, DestPort=None, Ipv4DestAddress=None + ): + """Base class infrastructure that gets a list of twampIpv4DstList device ids encapsulated by this object. + + Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. + + Args + ---- + - PortNames (str): optional regex of port names + - Active (str): optional regex of active + - DestPort (str): optional regex of destPort + - Ipv4DestAddress (str): optional regex of ipv4DestAddress + + Returns + ------- + - list(int): A list of device ids that meets the regex criteria provided in the method parameters + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._get_ngpf_device_ids(locals()) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/twampipv6_b1455e534d3dddd1d3626dedd3cd5690.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/twampipv6_b1455e534d3dddd1d3626dedd3cd5690.py new file mode 100644 index 000000000..3d76f8d25 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/twampipv6_b1455e534d3dddd1d3626dedd3cd5690.py @@ -0,0 +1,818 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class TwampIpv6(Base): + """Twamp IPv6 Session + The TwampIpv6 class encapsulates a list of twampIpv6 resources that are managed by the user. + A list of resources can be retrieved from the server using the TwampIpv6.find() method. + The list can be managed by using the TwampIpv6.add() and TwampIpv6.remove() methods. + """ + + __slots__ = () + _SDM_NAME = "twampIpv6" + _SDM_ATT_MAP = { + "Active": "active", + "AuthType": "authType", + "ConnectedVia": "connectedVia", + "Count": "count", + "DescriptiveName": "descriptiveName", + "EnableSSID": "enableSSID", + "Errors": "errors", + "HostMode": "hostMode", + "MeasurementType": "measurementType", + "Multiplier": "multiplier", + "Name": "name", + "NoOfDest": "noOfDest", + "NoOfPackets": "noOfPackets", + "PacketLength": "packetLength", + "PacketsPerSecond": "packetsPerSecond", + "PaddingWithZero": "paddingWithZero", + "ReflectorPort": "reflectorPort", + "Scale": "scale", + "SenderPort": "senderPort", + "SessionStatus": "sessionStatus", + "Sflag": "sflag", + "SrMode": "srMode", + "StackedLayers": "stackedLayers", + "StateCounts": "stateCounts", + "StateType": "stateType", + "StatsInterval": "statsInterval", + "StatsUpdateMode": "statsUpdateMode", + "Status": "status", + "Timeout": "timeout", + "TwampMode": "twampMode", + "Zflag": "zflag", + } + _SDM_ENUM_MAP = { + "status": [ + "configured", + "error", + "mixed", + "notStarted", + "started", + "starting", + "stopping", + ], + } + + def __init__(self, parent, list_op=False): + super(TwampIpv6, self).__init__(parent, list_op) + + @property + def TwampIpv6DstList(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.twampipv6dstlist_42a3d2c6bdade1f2352572052b2c13ab.TwampIpv6DstList): An instance of the TwampIpv6DstList class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.topology.twampipv6dstlist_42a3d2c6bdade1f2352572052b2c13ab import ( + TwampIpv6DstList, + ) + + if len(self._object_properties) > 0: + if self._properties.get("TwampIpv6DstList", None) is not None: + return self._properties.get("TwampIpv6DstList") + return TwampIpv6DstList(self)._select() + + @property + def Active(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Activate/Deactivate Configuration + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Active"])) + + @property + def AuthType(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the authentication mode of the host. Options are: Authenticated, UnAuthenticated. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["AuthType"])) + + @property + def ConnectedVia(self): + # type: () -> List[str] + """DEPRECATED + Returns + ------- + - list(str[None | /api/v1/sessions/1/ixnetwork/topology]): List of layers this layer is used to connect with to the wire. + """ + return self._get_attribute(self._SDM_ATT_MAP["ConnectedVia"]) + + @ConnectedVia.setter + def ConnectedVia(self, value): + # type: (List[str]) -> None + self._set_attribute(self._SDM_ATT_MAP["ConnectedVia"], value) + + @property + def Count(self): + # type: () -> int + """ + Returns + ------- + - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["Count"]) + + @property + def DescriptiveName(self): + # type: () -> str + """ + Returns + ------- + - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + """ + return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) + + @property + def EnableSSID(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Enable this option to Auto Configure the SSID when it is in the STAMP mode. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["EnableSSID"])) + + @property + def Errors(self): + """ + Returns + ------- + - list(dict(arg1:str[None | /api/v1/sessions/1/ixnetwork/],arg2:list[str])): A list of errors that have occurred + """ + return self._get_attribute(self._SDM_ATT_MAP["Errors"]) + + @property + def HostMode(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the mode in which the host should be running. Options are: Sender, Reflector. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["HostMode"])) + + @property + def MeasurementType(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the Measurement type of the host. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["MeasurementType"]) + ) + + @property + def Multiplier(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Multiplier is used for calculating error estimation. Error estimate = Multiplier*2^(-32)*2^Scale (in seconds). + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Multiplier"])) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + @property + def NoOfDest(self): + # type: () -> int + """ + Returns + ------- + - number: Specify the number of destinations to which the requests have to be sent. + """ + return self._get_attribute(self._SDM_ATT_MAP["NoOfDest"]) + + @NoOfDest.setter + def NoOfDest(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["NoOfDest"], value) + + @property + def NoOfPackets(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the Total number of test packets to be sent. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["NoOfPackets"])) + + @property + def PacketLength(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the total length of the packet with padding. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["PacketLength"])) + + @property + def PacketsPerSecond(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the rate at which packets should be sent per second. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["PacketsPerSecond"]) + ) + + @property + def PaddingWithZero(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Enable this option if Padding should be filled with Zero. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["PaddingWithZero"]) + ) + + @property + def ReflectorPort(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the starting UDP port. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["ReflectorPort"])) + + @property + def Scale(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Scale is used for calculating error estimation. Error estimate = Multiplier*2^(-32)*2^Scale (in seconds). + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Scale"])) + + @property + def SenderPort(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the starting UDP port. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["SenderPort"])) + + @property + def SessionStatus(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str[down | notStarted | up]): Current state of protocol session: Not Started - session negotiation not started, the session is not active yet. Down - actively trying to bring up a protocol session, but negotiation is didn't successfully complete (yet). Up - session came up successfully. + """ + return self._get_attribute(self._SDM_ATT_MAP["SessionStatus"]) + + @property + def Sflag(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Select this option if clock is synchronized to UTC using an external source. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Sflag"])) + + @property + def SrMode(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the Segment Routing Mode to be supported. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["SrMode"])) + + @property + def StackedLayers(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str[None | /api/v1/sessions/1/ixnetwork/topology]): List of secondary (many to one) child layer protocols + """ + return self._get_attribute(self._SDM_ATT_MAP["StackedLayers"]) + + @StackedLayers.setter + def StackedLayers(self, value): + # type: (List[str]) -> None + self._set_attribute(self._SDM_ATT_MAP["StackedLayers"], value) + + @property + def StateCounts(self): + """ + Returns + ------- + - dict(total:number,notStarted:number,down:number,up:number): A list of values that indicates the total number of sessions, the number of sessions not started, the number of sessions down and the number of sessions that are up + """ + return self._get_attribute(self._SDM_ATT_MAP["StateCounts"]) + + @property + def StateType(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the operation mode of the host. Options are: Statefull, Stateless. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["StateType"])) + + @property + def StatsInterval(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): This specifies the Interval at which Stats has to be updated periodically. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["StatsInterval"])) + + @property + def StatsUpdateMode(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the mode using which Stats needs to be updated. Continuous - All Stats will be updated perdiocally as per specified Stats Interval. ManualAction - Only Basic Tx, Rx, Loss, stats are updated every 2 sec, all other stats will be updated whenever Manual Action is triggered or test is completed. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["StatsUpdateMode"]) + ) + + @property + def Status(self): + # type: () -> str + """ + Returns + ------- + - str(configured | error | mixed | notStarted | started | starting | stopping): Running status of associated network element. Once in Started state, protocol sessions will begin to negotiate. + """ + return self._get_attribute(self._SDM_ATT_MAP["Status"]) + + @property + def Timeout(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the Timeout of Session Sender. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Timeout"])) + + @property + def TwampMode(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Determines the specific RFC that should be run by this Twamp device. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["TwampMode"])) + + @property + def Zflag(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Select this Option to indicate to the format of a collected timestamp. If disabled - NTP 64 bit format. If enabled - PTPv2-truncated format. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Zflag"])) + + def update(self, ConnectedVia=None, Name=None, NoOfDest=None, StackedLayers=None): + # type: (List[str], str, int, List[str]) -> TwampIpv6 + """Updates twampIpv6 resource on the server. + + This method has some named parameters with a type: obj (Multivalue). + The Multivalue class has documentation that details the possible values for those named parameters. + + Args + ---- + - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of layers this layer is used to connect with to the wire. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - NoOfDest (number): Specify the number of destinations to which the requests have to be sent. + - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of secondary (many to one) child layer protocols + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def add(self, ConnectedVia=None, Name=None, NoOfDest=None, StackedLayers=None): + # type: (List[str], str, int, List[str]) -> TwampIpv6 + """Adds a new twampIpv6 resource on the server and adds it to the container. + + Args + ---- + - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of layers this layer is used to connect with to the wire. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - NoOfDest (number): Specify the number of destinations to which the requests have to be sent. + - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of secondary (many to one) child layer protocols + + Returns + ------- + - self: This instance with all currently retrieved twampIpv6 resources using find and the newly added twampIpv6 resources available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._create(self._map_locals(self._SDM_ATT_MAP, locals())) + + def remove(self): + """Deletes all the contained twampIpv6 resources in this instance from the server. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + self._delete() + + def find( + self, + ConnectedVia=None, + Count=None, + DescriptiveName=None, + Errors=None, + Name=None, + NoOfDest=None, + SessionStatus=None, + StackedLayers=None, + StateCounts=None, + Status=None, + ): + """Finds and retrieves twampIpv6 resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve twampIpv6 resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all twampIpv6 resources from the server. + + Args + ---- + - ConnectedVia (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of layers this layer is used to connect with to the wire. + - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + - Errors (list(dict(arg1:str[None | /api/v1/sessions/1/ixnetwork/],arg2:list[str]))): A list of errors that have occurred + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + - NoOfDest (number): Specify the number of destinations to which the requests have to be sent. + - SessionStatus (list(str[down | notStarted | up])): Current state of protocol session: Not Started - session negotiation not started, the session is not active yet. Down - actively trying to bring up a protocol session, but negotiation is didn't successfully complete (yet). Up - session came up successfully. + - StackedLayers (list(str[None | /api/v1/sessions/1/ixnetwork/topology])): List of secondary (many to one) child layer protocols + - StateCounts (dict(total:number,notStarted:number,down:number,up:number)): A list of values that indicates the total number of sessions, the number of sessions not started, the number of sessions down and the number of sessions that are up + - Status (str(configured | error | mixed | notStarted | started | starting | stopping)): Running status of associated network element. Once in Started state, protocol sessions will begin to negotiate. + + Returns + ------- + - self: This instance with matching twampIpv6 resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of twampIpv6 data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the twampIpv6 resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) + + def Abort(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the abort operation on the server. + + Abort CPF control plane (equals to demote to kUnconfigured state). + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + abort(async_operation=bool) + --------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + abort(SessionIndices=list, async_operation=bool) + ------------------------------------------------ + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + abort(SessionIndices=string, async_operation=bool) + -------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("abort", payload=payload, response_object=None) + + def GetStatistics(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the getStatistics operation on the server. + + Sends a Statistics Request message. + + getStatistics(Arg2=list, async_operation=bool)list + -------------------------------------------------- + - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self.href} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("getStatistics", payload=payload, response_object=None) + + def RestartDown(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the restartDown operation on the server. + + Stop and start interfaces and sessions that are in Down state. + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + restartDown(async_operation=bool) + --------------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + restartDown(SessionIndices=list, async_operation=bool) + ------------------------------------------------------ + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + restartDown(SessionIndices=string, async_operation=bool) + -------------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("restartDown", payload=payload, response_object=None) + + def Start(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the start operation on the server. + + Start CPF control plane (equals to promote to negotiated state). + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + start(async_operation=bool) + --------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + start(SessionIndices=list, async_operation=bool) + ------------------------------------------------ + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + start(SessionIndices=string, async_operation=bool) + -------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("start", payload=payload, response_object=None) + + def Stop(self, *args, **kwargs): + # type: (*Any, **Any) -> None + """Executes the stop operation on the server. + + Stop CPF control plane (equals to demote to PreValidated-DoDDone state). + + The IxNetwork model allows for multiple method Signatures with the same name while python does not. + + stop(async_operation=bool) + -------------------------- + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + stop(SessionIndices=list, async_operation=bool) + ----------------------------------------------- + - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + stop(SessionIndices=string, async_operation=bool) + ------------------------------------------------- + - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12 + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("stop", payload=payload, response_object=None) + + def get_device_ids( + self, + PortNames=None, + Active=None, + AuthType=None, + EnableSSID=None, + HostMode=None, + MeasurementType=None, + Multiplier=None, + NoOfPackets=None, + PacketLength=None, + PacketsPerSecond=None, + PaddingWithZero=None, + ReflectorPort=None, + Scale=None, + SenderPort=None, + Sflag=None, + SrMode=None, + StateType=None, + StatsInterval=None, + StatsUpdateMode=None, + Timeout=None, + TwampMode=None, + Zflag=None, + ): + """Base class infrastructure that gets a list of twampIpv6 device ids encapsulated by this object. + + Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. + + Args + ---- + - PortNames (str): optional regex of port names + - Active (str): optional regex of active + - AuthType (str): optional regex of authType + - EnableSSID (str): optional regex of enableSSID + - HostMode (str): optional regex of hostMode + - MeasurementType (str): optional regex of measurementType + - Multiplier (str): optional regex of multiplier + - NoOfPackets (str): optional regex of noOfPackets + - PacketLength (str): optional regex of packetLength + - PacketsPerSecond (str): optional regex of packetsPerSecond + - PaddingWithZero (str): optional regex of paddingWithZero + - ReflectorPort (str): optional regex of reflectorPort + - Scale (str): optional regex of scale + - SenderPort (str): optional regex of senderPort + - Sflag (str): optional regex of sflag + - SrMode (str): optional regex of srMode + - StateType (str): optional regex of stateType + - StatsInterval (str): optional regex of statsInterval + - StatsUpdateMode (str): optional regex of statsUpdateMode + - Timeout (str): optional regex of timeout + - TwampMode (str): optional regex of twampMode + - Zflag (str): optional regex of zflag + + Returns + ------- + - list(int): A list of device ids that meets the regex criteria provided in the method parameters + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._get_ngpf_device_ids(locals()) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/twampipv6dstlist_42a3d2c6bdade1f2352572052b2c13ab.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/twampipv6dstlist_42a3d2c6bdade1f2352572052b2c13ab.py new file mode 100644 index 000000000..900771a4a --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/topology/twampipv6dstlist_42a3d2c6bdade1f2352572052b2c13ab.py @@ -0,0 +1,252 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class TwampIpv6DstList(Base): + """Twamp IPv6 Destinations + The TwampIpv6DstList class encapsulates a required twampIpv6DstList resource which will be retrieved from the server every time the property is accessed. + """ + + __slots__ = () + _SDM_NAME = "twampIpv6DstList" + _SDM_ATT_MAP = { + "Active": "active", + "Count": "count", + "DescriptiveName": "descriptiveName", + "DestPort": "destPort", + "DestinationIPv6": "destinationIPv6", + "Name": "name", + } + _SDM_ENUM_MAP = {} + + def __init__(self, parent, list_op=False): + super(TwampIpv6DstList, self).__init__(parent, list_op) + + @property + def Active(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Activate/Deactivate Configuration. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Active"])) + + @property + def Count(self): + # type: () -> int + """ + Returns + ------- + - number: Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["Count"]) + + @property + def DescriptiveName(self): + # type: () -> str + """ + Returns + ------- + - str: Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + """ + return self._get_attribute(self._SDM_ATT_MAP["DescriptiveName"]) + + @property + def DestPort(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the destination port to which request has to be sent. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["DestPort"])) + + @property + def DestinationIPv6(self): + # type: () -> 'Multivalue' + """ + Returns + ------- + - obj(ixnetwork_restpy.multivalue.Multivalue): Specify the IPv6 destination address to which request has to be sent. + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["DestinationIPv6"]) + ) + + @property + def Name(self): + # type: () -> str + """ + Returns + ------- + - str: Name of NGPF element, guaranteed to be unique in Scenario + """ + return self._get_attribute(self._SDM_ATT_MAP["Name"]) + + @Name.setter + def Name(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Name"], value) + + def update(self, Name=None): + # type: (str) -> TwampIpv6DstList + """Updates twampIpv6DstList resource on the server. + + This method has some named parameters with a type: obj (Multivalue). + The Multivalue class has documentation that details the possible values for those named parameters. + + Args + ---- + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find(self, Count=None, DescriptiveName=None, Name=None): + # type: (int, str, str) -> TwampIpv6DstList + """Finds and retrieves twampIpv6DstList resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve twampIpv6DstList resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all twampIpv6DstList resources from the server. + + Args + ---- + - Count (number): Number of elements inside associated multiplier-scaled container object, e.g. number of devices inside a Device Group. + - DescriptiveName (str): Longer, more descriptive name for element. It's not guaranteed to be unique like -name-, but may offer more context. + - Name (str): Name of NGPF element, guaranteed to be unique in Scenario + + Returns + ------- + - self: This instance with matching twampIpv6DstList resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of twampIpv6DstList data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the twampIpv6DstList resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) + + def SendTwampRequest(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the sendTwampRequest operation on the server. + + Sends a Twamp Request message. + + sendTwampRequest(Arg2=list, async_operation=bool)list + ----------------------------------------------------- + - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self.href} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("sendTwampRequest", payload=payload, response_object=None) + + def StopTwampRequest(self, *args, **kwargs): + # type: (*Any, **Any) -> Union[List[str], None] + """Executes the stopTwampRequest operation on the server. + + Sends a Twamp Stop Request message. + + stopTwampRequest(Arg2=list, async_operation=bool)list + ----------------------------------------------------- + - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin. + - async_operation (bool=False): True to execute the operation asynchronously. Any subsequent rest api calls made through the Connection class will block until the operation is complete. + - Returns list(str): ID to associate each action invocation + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + payload = {"Arg1": self.href} + for i in range(len(args)): + payload["Arg%s" % (i + 2)] = args[i] + for item in kwargs.items(): + payload[item[0]] = item[1] + return self._execute("stopTwampRequest", payload=payload, response_object=None) + + def get_device_ids( + self, PortNames=None, Active=None, DestPort=None, DestinationIPv6=None + ): + """Base class infrastructure that gets a list of twampIpv6DstList device ids encapsulated by this object. + + Use the optional regex parameters in the method to refine the list of device ids encapsulated by this object. + + Args + ---- + - PortNames (str): optional regex of port names + - Active (str): optional regex of active + - DestPort (str): optional regex of destPort + - DestinationIPv6 (str): optional regex of destinationIPv6 + + Returns + ------- + - list(int): A list of device ids that meets the regex criteria provided in the method parameters + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._get_ngpf_device_ids(locals()) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/dynamicframesize/dynamicframesize.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/dynamicframesize/dynamicframesize.py index c7ece53c4..38173bb59 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/dynamicframesize/dynamicframesize.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/dynamicframesize/dynamicframesize.py @@ -71,7 +71,7 @@ def HighLevelStreamName(self): """ Returns ------- - - str: The name of the high level stream + - str: The name of the high level stream. """ return self._get_attribute(self._SDM_ATT_MAP["HighLevelStreamName"]) @@ -121,7 +121,7 @@ def Type(self): """ Returns ------- - - str(fixed | random): Sets the frame size to either fixed or random lengths in bytes. + - str(fixed | random): Sets the frame size type to either fixed or random lengths in bytes. """ return self._get_attribute(self._SDM_ATT_MAP["Type"]) @@ -139,7 +139,7 @@ def update(self, FixedSize=None, RandomMax=None, RandomMin=None, Type=None): - FixedSize (number): Sets all frames to a specified constant size. The default is 64 bytes. - RandomMax (number): Sets frame size to maximum length in bytes. The maximum length is 65536 bytes. - RandomMin (number): Sets frame size to minimum length in bytes. The minimum length is 12 bytes. - - Type (str(fixed | random)): Sets the frame size to either fixed or random lengths in bytes. + - Type (str(fixed | random)): Sets the frame size type to either fixed or random lengths in bytes. Raises ------ @@ -156,7 +156,7 @@ def add(self, FixedSize=None, RandomMax=None, RandomMin=None, Type=None): - FixedSize (number): Sets all frames to a specified constant size. The default is 64 bytes. - RandomMax (number): Sets frame size to maximum length in bytes. The maximum length is 65536 bytes. - RandomMin (number): Sets frame size to minimum length in bytes. The minimum length is 12 bytes. - - Type (str(fixed | random)): Sets the frame size to either fixed or random lengths in bytes. + - Type (str(fixed | random)): Sets the frame size type to either fixed or random lengths in bytes. Returns ------- @@ -187,11 +187,11 @@ def find( Args ---- - FixedSize (number): Sets all frames to a specified constant size. The default is 64 bytes. - - HighLevelStreamName (str): The name of the high level stream + - HighLevelStreamName (str): The name of the high level stream. - RandomMax (number): Sets frame size to maximum length in bytes. The maximum length is 65536 bytes. - RandomMin (number): Sets frame size to minimum length in bytes. The minimum length is 12 bytes. - TrafficItemName (str): The name of the parent traffic item. - - Type (str(fixed | random)): Sets the frame size to either fixed or random lengths in bytes. + - Type (str(fixed | random)): Sets the frame size type to either fixed or random lengths in bytes. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/dynamicrate/dynamicrate.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/dynamicrate/dynamicrate.py index f66a4a811..a203e794e 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/dynamicrate/dynamicrate.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/dynamicrate/dynamicrate.py @@ -79,7 +79,7 @@ def BitRateUnitsType(self): """ Returns ------- - - str(bitsPerSec | bytesPerSec | kbitsPerSec | kbytesPerSec | mbitsPerSec | mbytesPerSec): The rate units for transmitting packet. + - str(bitsPerSec | bytesPerSec | kbitsPerSec | kbytesPerSec | mbitsPerSec | mbytesPerSec): The unit of rate for transmitting packet. """ return self._get_attribute(self._SDM_ATT_MAP["BitRateUnitsType"]) @@ -109,7 +109,7 @@ def HighLevelStreamName(self): """ Returns ------- - - str: The name of the high level stream + - str: The name of the high level stream. """ return self._get_attribute(self._SDM_ATT_MAP["HighLevelStreamName"]) @@ -119,7 +119,7 @@ def InterPacketGapUnitsType(self): """ Returns ------- - - str(bytes | microseconds | milliseconds | nanoseconds | seconds): The inter-packet gap expressed in units. + - str(bytes | microseconds | milliseconds | nanoseconds | seconds): The inter-packet gap expressed in units of time. Available units of time: bytes, nanoseconds, microseconds, milliseconds, seconds. """ return self._get_attribute(self._SDM_ATT_MAP["InterPacketGapUnitsType"]) @@ -134,7 +134,7 @@ def OverSubscribed(self): """ Returns ------- - - bool: If true, the packet transmission rate is oversubscribed. + - bool: Determines whether the packet transmission rate is oversubscribed. """ return self._get_attribute(self._SDM_ATT_MAP["OverSubscribed"]) @@ -159,7 +159,7 @@ def RateType(self): """ Returns ------- - - str(bitsPerSecond | framesPerSecond | interPacketGap | percentLineRate): The types of packet rate transmission. + - str(bitsPerSecond | framesPerSecond | interPacketGap | percentLineRate): The type of packet rate transmission. """ return self._get_attribute(self._SDM_ATT_MAP["RateType"]) @@ -184,7 +184,7 @@ def TxPort(self): """ Returns ------- - - number: The transmitting port. + - number: Returns the transmitting (Tx) port, the port sending the data. """ return self._get_attribute(self._SDM_ATT_MAP["TxPort"]) @@ -201,11 +201,11 @@ def update( Args ---- - - BitRateUnitsType (str(bitsPerSec | bytesPerSec | kbitsPerSec | kbytesPerSec | mbitsPerSec | mbytesPerSec)): The rate units for transmitting packet. + - BitRateUnitsType (str(bitsPerSec | bytesPerSec | kbitsPerSec | kbytesPerSec | mbitsPerSec | mbytesPerSec)): The unit of rate for transmitting packet. - EnforceMinimumInterPacketGap (number): Sets the minimum inter-packet gap allowed for Ethernet ports only. The default is 12 bytes. - - InterPacketGapUnitsType (str(bytes | microseconds | milliseconds | nanoseconds | seconds)): The inter-packet gap expressed in units. + - InterPacketGapUnitsType (str(bytes | microseconds | milliseconds | nanoseconds | seconds)): The inter-packet gap expressed in units of time. Available units of time: bytes, nanoseconds, microseconds, milliseconds, seconds. - Rate (number): The rate at which packet is transmitted. - - RateType (str(bitsPerSecond | framesPerSecond | interPacketGap | percentLineRate)): The types of packet rate transmission. + - RateType (str(bitsPerSecond | framesPerSecond | interPacketGap | percentLineRate)): The type of packet rate transmission. Raises ------ @@ -226,11 +226,11 @@ def add( Args ---- - - BitRateUnitsType (str(bitsPerSec | bytesPerSec | kbitsPerSec | kbytesPerSec | mbitsPerSec | mbytesPerSec)): The rate units for transmitting packet. + - BitRateUnitsType (str(bitsPerSec | bytesPerSec | kbitsPerSec | kbytesPerSec | mbitsPerSec | mbytesPerSec)): The unit of rate for transmitting packet. - EnforceMinimumInterPacketGap (number): Sets the minimum inter-packet gap allowed for Ethernet ports only. The default is 12 bytes. - - InterPacketGapUnitsType (str(bytes | microseconds | milliseconds | nanoseconds | seconds)): The inter-packet gap expressed in units. + - InterPacketGapUnitsType (str(bytes | microseconds | milliseconds | nanoseconds | seconds)): The inter-packet gap expressed in units of time. Available units of time: bytes, nanoseconds, microseconds, milliseconds, seconds. - Rate (number): The rate at which packet is transmitted. - - RateType (str(bitsPerSecond | framesPerSecond | interPacketGap | percentLineRate)): The types of packet rate transmission. + - RateType (str(bitsPerSecond | framesPerSecond | interPacketGap | percentLineRate)): The type of packet rate transmission. Returns ------- @@ -263,15 +263,15 @@ def find( Args ---- - - BitRateUnitsType (str(bitsPerSec | bytesPerSec | kbitsPerSec | kbytesPerSec | mbitsPerSec | mbytesPerSec)): The rate units for transmitting packet. + - BitRateUnitsType (str(bitsPerSec | bytesPerSec | kbitsPerSec | kbytesPerSec | mbitsPerSec | mbytesPerSec)): The unit of rate for transmitting packet. - EnforceMinimumInterPacketGap (number): Sets the minimum inter-packet gap allowed for Ethernet ports only. The default is 12 bytes. - - HighLevelStreamName (str): The name of the high level stream - - InterPacketGapUnitsType (str(bytes | microseconds | milliseconds | nanoseconds | seconds)): The inter-packet gap expressed in units. - - OverSubscribed (bool): If true, the packet transmission rate is oversubscribed. + - HighLevelStreamName (str): The name of the high level stream. + - InterPacketGapUnitsType (str(bytes | microseconds | milliseconds | nanoseconds | seconds)): The inter-packet gap expressed in units of time. Available units of time: bytes, nanoseconds, microseconds, milliseconds, seconds. + - OverSubscribed (bool): Determines whether the packet transmission rate is oversubscribed. - Rate (number): The rate at which packet is transmitted. - - RateType (str(bitsPerSecond | framesPerSecond | interPacketGap | percentLineRate)): The types of packet rate transmission. + - RateType (str(bitsPerSecond | framesPerSecond | interPacketGap | percentLineRate)): The type of packet rate transmission. - TrafficItemName (str): The name of the parent traffic item. - - TxPort (number): The transmitting port. + - TxPort (number): Returns the transmitting (Tx) port, the port sending the data. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/egressonlytracking/egressonlytracking.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/egressonlytracking/egressonlytracking.py index 7a964aabb..dfb7dd425 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/egressonlytracking/egressonlytracking.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/egressonlytracking/egressonlytracking.py @@ -58,7 +58,7 @@ def Egress(self): """ Returns ------- - - list(dict(arg1:number,arg2:str)): Struct contains: egress offset and egress mask + - list(dict(arg1:number,arg2:str)): The list of structures containing Egress Mask and Offset to be placed in the packet. There can be at most 3 Egress values on a port and Egress Offset values should be always even. """ return self._get_attribute(self._SDM_ATT_MAP["Egress"]) @@ -87,7 +87,7 @@ def Port(self): """ Returns ------- - - str(None | /api/v1/sessions/1/ixnetwork/lag | /api/v1/sessions/1/ixnetwork/vport): + - str(None | /api/v1/sessions/1/ixnetwork/lag | /api/v1/sessions/1/ixnetwork/vport): Sets the port on which Egress Tracking is enabled. """ return self._get_attribute(self._SDM_ATT_MAP["Port"]) @@ -115,7 +115,7 @@ def SignatureLengthType(self): """ Returns ------- - - str(fourByte | twelveByte): + - str(fourByte | twelveByte): Sets the Signature Length Type. """ return self._get_attribute(self._SDM_ATT_MAP["SignatureLengthType"]) @@ -130,7 +130,7 @@ def SignatureMask(self): """ Returns ------- - - str: Signature maks to be placed inside the packet. + - str: Signature mask to be placed inside the packet. """ return self._get_attribute(self._SDM_ATT_MAP["SignatureMask"]) @@ -184,12 +184,12 @@ def update( Args ---- - - Egress (list(dict(arg1:number,arg2:str))): Struct contains: egress offset and egress mask + - Egress (list(dict(arg1:number,arg2:str))): The list of structures containing Egress Mask and Offset to be placed in the packet. There can be at most 3 Egress values on a port and Egress Offset values should be always even. - Enabled (bool): Enables the egress only tracking for the given port. - - Port (str(None | /api/v1/sessions/1/ixnetwork/lag | /api/v1/sessions/1/ixnetwork/vport)): + - Port (str(None | /api/v1/sessions/1/ixnetwork/lag | /api/v1/sessions/1/ixnetwork/vport)): Sets the port on which Egress Tracking is enabled. - QbvSettings (list(dict(arg1:bool,arg2:number,arg3:bool,arg4:str))): Structure contains a mapping between the gate and the field value in the packet pointed to by egress offset. Besides, it also denotes if an entry is enabled and the gate number is to be treated as the default gate. - - SignatureLengthType (str(fourByte | twelveByte)): - - SignatureMask (str): Signature maks to be placed inside the packet. + - SignatureLengthType (str(fourByte | twelveByte)): Sets the Signature Length Type. + - SignatureMask (str): Signature mask to be placed inside the packet. - SignatureOffset (number): Offset where the signature value will be placed in the packet. - SignatureValue (str): Signature value to be placed inside the packet. @@ -214,12 +214,12 @@ def add( Args ---- - - Egress (list(dict(arg1:number,arg2:str))): Struct contains: egress offset and egress mask + - Egress (list(dict(arg1:number,arg2:str))): The list of structures containing Egress Mask and Offset to be placed in the packet. There can be at most 3 Egress values on a port and Egress Offset values should be always even. - Enabled (bool): Enables the egress only tracking for the given port. - - Port (str(None | /api/v1/sessions/1/ixnetwork/lag | /api/v1/sessions/1/ixnetwork/vport)): + - Port (str(None | /api/v1/sessions/1/ixnetwork/lag | /api/v1/sessions/1/ixnetwork/vport)): Sets the port on which Egress Tracking is enabled. - QbvSettings (list(dict(arg1:bool,arg2:number,arg3:bool,arg4:str))): Structure contains a mapping between the gate and the field value in the packet pointed to by egress offset. Besides, it also denotes if an entry is enabled and the gate number is to be treated as the default gate. - - SignatureLengthType (str(fourByte | twelveByte)): - - SignatureMask (str): Signature maks to be placed inside the packet. + - SignatureLengthType (str(fourByte | twelveByte)): Sets the Signature Length Type. + - SignatureMask (str): Signature mask to be placed inside the packet. - SignatureOffset (number): Offset where the signature value will be placed in the packet. - SignatureValue (str): Signature value to be placed inside the packet. @@ -262,12 +262,12 @@ def find( Args ---- - - Egress (list(dict(arg1:number,arg2:str))): Struct contains: egress offset and egress mask + - Egress (list(dict(arg1:number,arg2:str))): The list of structures containing Egress Mask and Offset to be placed in the packet. There can be at most 3 Egress values on a port and Egress Offset values should be always even. - Enabled (bool): Enables the egress only tracking for the given port. - - Port (str(None | /api/v1/sessions/1/ixnetwork/lag | /api/v1/sessions/1/ixnetwork/vport)): + - Port (str(None | /api/v1/sessions/1/ixnetwork/lag | /api/v1/sessions/1/ixnetwork/vport)): Sets the port on which Egress Tracking is enabled. - QbvSettings (list(dict(arg1:bool,arg2:number,arg3:bool,arg4:str))): Structure contains a mapping between the gate and the field value in the packet pointed to by egress offset. Besides, it also denotes if an entry is enabled and the gate number is to be treated as the default gate. - - SignatureLengthType (str(fourByte | twelveByte)): - - SignatureMask (str): Signature maks to be placed inside the packet. + - SignatureLengthType (str(fourByte | twelveByte)): Sets the Signature Length Type. + - SignatureMask (str): Signature mask to be placed inside the packet. - SignatureOffset (number): Offset where the signature value will be placed in the packet. - SignatureValue (str): Signature value to be placed inside the packet. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/protocoltemplate/field/field.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/protocoltemplate/field/field.py index 472be6fd0..3e562210a 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/protocoltemplate/field/field.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/protocoltemplate/field/field.py @@ -73,7 +73,7 @@ def FieldTypeId(self): """ Returns ------- - - str: + - str: A unique identifier to recognize the field in protocol template stack. """ return self._get_attribute(self._SDM_ATT_MAP["FieldTypeId"]) @@ -93,7 +93,7 @@ def Trackable(self): """ Returns ------- - - bool: The trackable fields. + - bool: Denotes whether the field can be tracked or not. """ return self._get_attribute(self._SDM_ATT_MAP["Trackable"]) @@ -124,9 +124,9 @@ def find( ---- - Id__ (str): An alphanumeric string that defines the internal field ID. - DisplayName (str): It is used to get the name of the particular field as available in the protocol template. - - FieldTypeId (str): + - FieldTypeId (str): A unique identifier to recognize the field in protocol template stack. - Length (number): It is used to get the length of the field in bits. - - Trackable (bool): The trackable fields. + - Trackable (bool): Denotes whether the field can be tracked or not. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/protocoltemplate/protocoltemplate.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/protocoltemplate/protocoltemplate.py index bb4c35135..929e9dd59 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/protocoltemplate/protocoltemplate.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/protocoltemplate/protocoltemplate.py @@ -81,7 +81,7 @@ def StackTypeId(self): """ Returns ------- - - str: + - str: A unique identifier to recognize the protocol stack. """ return self._get_attribute(self._SDM_ATT_MAP["StackTypeId"]) @@ -119,7 +119,7 @@ def find(self, DisplayName=None, StackTypeId=None, TemplateName=None): Args ---- - DisplayName (str): The display name of the template. - - StackTypeId (str): + - StackTypeId (str): A unique identifier to recognize the protocol stack. - TemplateName (str): Indicates the protocol template name that is added to a packet. Returns diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/statistics/dataintegrity/dataintegrity.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/statistics/dataintegrity/dataintegrity.py index ee793b219..70696f480 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/statistics/dataintegrity/dataintegrity.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/statistics/dataintegrity/dataintegrity.py @@ -35,6 +35,7 @@ class DataIntegrity(Base): __slots__ = () _SDM_NAME = "dataIntegrity" _SDM_ATT_MAP = { + "DataIntegrityVirtualPorts": "dataIntegrityVirtualPorts", "Enabled": "enabled", } _SDM_ENUM_MAP = {} @@ -42,6 +43,21 @@ class DataIntegrity(Base): def __init__(self, parent, list_op=False): super(DataIntegrity, self).__init__(parent, list_op) + @property + def DataIntegrityVirtualPorts(self): + # type: () -> bool + """ + Returns + ------- + - bool: If true, enables and fetches data integrity statistics on Virtual Ports + """ + return self._get_attribute(self._SDM_ATT_MAP["DataIntegrityVirtualPorts"]) + + @DataIntegrityVirtualPorts.setter + def DataIntegrityVirtualPorts(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["DataIntegrityVirtualPorts"], value) + @property def Enabled(self): # type: () -> bool @@ -57,12 +73,13 @@ def Enabled(self, value): # type: (bool) -> None self._set_attribute(self._SDM_ATT_MAP["Enabled"], value) - def update(self, Enabled=None): - # type: (bool) -> DataIntegrity + def update(self, DataIntegrityVirtualPorts=None, Enabled=None): + # type: (bool, bool) -> DataIntegrity """Updates dataIntegrity resource on the server. Args ---- + - DataIntegrityVirtualPorts (bool): If true, enables and fetches data integrity statistics on Virtual Ports - Enabled (bool): If true, enables and fetches data integrity statistics Raises @@ -71,8 +88,8 @@ def update(self, Enabled=None): """ return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) - def find(self, Enabled=None): - # type: (bool) -> DataIntegrity + def find(self, DataIntegrityVirtualPorts=None, Enabled=None): + # type: (bool, bool) -> DataIntegrity """Finds and retrieves dataIntegrity resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve dataIntegrity resources from the server. @@ -81,6 +98,7 @@ def find(self, Enabled=None): Args ---- + - DataIntegrityVirtualPorts (bool): If true, enables and fetches data integrity statistics on Virtual Ports - Enabled (bool): If true, enables and fetches data integrity statistics Returns diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibflow/connection/connection.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibflow/connection/connection.py index eea31a4b3..8cbd348a0 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibflow/connection/connection.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibflow/connection/connection.py @@ -91,7 +91,7 @@ def IsTCP(self): """ Returns ------- - - bool: (Read only) Application library flow connection type - true is the type is TCP, false if it's UDP. + - bool: (Read only) Application library flow connection types. True: When the type is TCP. False: When type is UDP. """ return self._get_attribute(self._SDM_ATT_MAP["IsTCP"]) @@ -120,7 +120,7 @@ def find(self, ConnectionId=None, ConnectionParams=None, IsTCP=None): ---- - ConnectionId (number): (Read only) Application library flow connection id. - ConnectionParams (list(str)): (Read only) Names of parameter available on application flow connection. - - IsTCP (bool): (Read only) Application library flow connection type - true is the type is TCP, false if it's UDP. + - IsTCP (bool): (Read only) Application library flow connection types. True: When the type is TCP. False: When type is UDP. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibflow/connection/parameter/parameter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibflow/connection/parameter/parameter.py index 81dd60f8b..a3a5363f3 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibflow/connection/parameter/parameter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibflow/connection/parameter/parameter.py @@ -173,7 +173,7 @@ def DisplayValue(self): """ Returns ------- - - str: Current parameter UI Display Value + - str: Current parameter UI Display Value. """ return self._get_attribute(self._SDM_ATT_MAP["DisplayValue"]) @@ -183,7 +183,7 @@ def Option(self): """ Returns ------- - - str(choice | range | value): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute + - str(choice | range | value): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute. """ return self._get_attribute(self._SDM_ATT_MAP["Option"]) @@ -198,7 +198,7 @@ def SupportedOptions(self): """ Returns ------- - - list(str[choice | range | value]): Runtime supported options for a specific parameter + - list(str[choice | range | value]): Runtime supported options for a specific parameter. """ return self._get_attribute(self._SDM_ATT_MAP["SupportedOptions"]) @@ -208,7 +208,7 @@ def update(self, Option=None): Args ---- - - Option (str(choice | range | value)): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute + - Option (str(choice | range | value)): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute. Raises ------ @@ -222,7 +222,7 @@ def add(self, Option=None): Args ---- - - Option (str(choice | range | value)): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute + - Option (str(choice | range | value)): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute. Returns ------- @@ -244,9 +244,9 @@ def find(self, DisplayValue=None, Option=None, SupportedOptions=None): Args ---- - - DisplayValue (str): Current parameter UI Display Value - - Option (str(choice | range | value)): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute - - SupportedOptions (list(str[choice | range | value])): Runtime supported options for a specific parameter + - DisplayValue (str): Current parameter UI Display Value. + - Option (str(choice | range | value)): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute. + - SupportedOptions (list(str[choice | range | value])): Runtime supported options for a specific parameter. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibflow/parameter/parameter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibflow/parameter/parameter.py index 94cb8058c..d770026a3 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibflow/parameter/parameter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibflow/parameter/parameter.py @@ -173,7 +173,7 @@ def DisplayValue(self): """ Returns ------- - - str: Current parameter UI Display Value + - str: Current parameter UI Display Value. """ return self._get_attribute(self._SDM_ATT_MAP["DisplayValue"]) @@ -183,7 +183,7 @@ def Option(self): """ Returns ------- - - str(choice | range | value): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute + - str(choice | range | value): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute. """ return self._get_attribute(self._SDM_ATT_MAP["Option"]) @@ -198,7 +198,7 @@ def SupportedOptions(self): """ Returns ------- - - list(str[choice | range | value]): Runtime supported options for a specific parameter + - list(str[choice | range | value]): Runtime supported options for a specific parameter. """ return self._get_attribute(self._SDM_ATT_MAP["SupportedOptions"]) @@ -208,7 +208,7 @@ def update(self, Option=None): Args ---- - - Option (str(choice | range | value)): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute + - Option (str(choice | range | value)): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute. Raises ------ @@ -222,7 +222,7 @@ def add(self, Option=None): Args ---- - - Option (str(choice | range | value)): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute + - Option (str(choice | range | value)): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute. Returns ------- @@ -244,9 +244,9 @@ def find(self, DisplayValue=None, Option=None, SupportedOptions=None): Args ---- - - DisplayValue (str): Current parameter UI Display Value - - Option (str(choice | range | value)): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute - - SupportedOptions (list(str[choice | range | value])): Runtime supported options for a specific parameter + - DisplayValue (str): Current parameter UI Display Value. + - Option (str(choice | range | value)): Each parameter has one or multiple options. Runtime supported options for specific parameter can be retrieved from supportedOptions attribute. + - SupportedOptions (list(str[choice | range | value])): Runtime supported options for a specific parameter. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibprofile.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibprofile.py index 482e048c5..705d5ffc0 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibprofile.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/applibprofile/applibprofile.py @@ -113,7 +113,7 @@ def EnablePerIPStats(self): """ Returns ------- - - bool: Enable Per IP Stats. When true then Per IP statistic drilldown is available. + - bool: Enable Per IP Stats. When true, the Per IP statistic drilldown is available. """ return self._get_attribute(self._SDM_ATT_MAP["EnablePerIPStats"]) @@ -143,7 +143,7 @@ def ObjectiveType(self): """ Returns ------- - - str(simulatedUsers | throughputGbps | throughputKbps | throughputMbps): The objective type of the test.A Test Objective is the way the user sets the actual rate of the Application Library Traffic transmission. + - str(simulatedUsers | throughputGbps | throughputKbps | throughputMbps): The objective type of the test. A Test Objective is the way the user sets the actual rate of the Application Library Traffic transmission. """ return self._get_attribute(self._SDM_ATT_MAP["ObjectiveType"]) @@ -158,7 +158,7 @@ def ObjectiveValue(self): """ Returns ------- - - number: The absolute value of either simulated users or throughput in its measure unit. + - number: The absolute value of either simulated users or throughput in its unit of measurement. """ return self._get_attribute(self._SDM_ATT_MAP["ObjectiveValue"]) @@ -173,7 +173,7 @@ def TrafficState(self): """ Returns ------- - - str(Configured | Interim | Running | Unconfigured): (Read only) A read-only field which indicates the current state of the traffic item. + - str(Configured | Interim | Running | Unconfigured): (Read only) A read-only field that indicates the current state of the traffic item. """ return self._get_attribute(self._SDM_ATT_MAP["TrafficState"]) @@ -191,10 +191,10 @@ def update( Args ---- - ConfiguredFlows (list(str[Bandwidth_HTTP | Bandwidth_Raw | BBC_iPlayer | BitTorrent_Cisco_EMIX | eDonkey_Data_Transfer | Evergreen_Web_ICQ_Jul_17_Send_Message | Facebook | Flash_Enterprise | HTTPS_Simulated_Enterprise])): Configured application library flows within profile. - - EnablePerIPStats (bool): Enable Per IP Stats. When true then Per IP statistic drilldown is available. + - EnablePerIPStats (bool): Enable Per IP Stats. When true, the Per IP statistic drilldown is available. - ObjectiveDistribution (str(applyFullObjectiveToEachPort | splitObjectiveEvenlyAmongPorts)): Objective distribution value. - - ObjectiveType (str(simulatedUsers | throughputGbps | throughputKbps | throughputMbps)): The objective type of the test.A Test Objective is the way the user sets the actual rate of the Application Library Traffic transmission. - - ObjectiveValue (number): The absolute value of either simulated users or throughput in its measure unit. + - ObjectiveType (str(simulatedUsers | throughputGbps | throughputKbps | throughputMbps)): The objective type of the test. A Test Objective is the way the user sets the actual rate of the Application Library Traffic transmission. + - ObjectiveValue (number): The absolute value of either simulated users or throughput in its unit of measurement. Raises ------ @@ -216,10 +216,10 @@ def add( Args ---- - ConfiguredFlows (list(str[Bandwidth_HTTP | Bandwidth_Raw | BBC_iPlayer | BitTorrent_Cisco_EMIX | eDonkey_Data_Transfer | Evergreen_Web_ICQ_Jul_17_Send_Message | Facebook | Flash_Enterprise | HTTPS_Simulated_Enterprise])): Configured application library flows within profile. - - EnablePerIPStats (bool): Enable Per IP Stats. When true then Per IP statistic drilldown is available. + - EnablePerIPStats (bool): Enable Per IP Stats. When true, the Per IP statistic drilldown is available. - ObjectiveDistribution (str(applyFullObjectiveToEachPort | splitObjectiveEvenlyAmongPorts)): Objective distribution value. - - ObjectiveType (str(simulatedUsers | throughputGbps | throughputKbps | throughputMbps)): The objective type of the test.A Test Objective is the way the user sets the actual rate of the Application Library Traffic transmission. - - ObjectiveValue (number): The absolute value of either simulated users or throughput in its measure unit. + - ObjectiveType (str(simulatedUsers | throughputGbps | throughputKbps | throughputMbps)): The objective type of the test. A Test Objective is the way the user sets the actual rate of the Application Library Traffic transmission. + - ObjectiveValue (number): The absolute value of either simulated users or throughput in its unit of measurement. Returns ------- @@ -262,11 +262,11 @@ def find( ---- - AvailableFlows (list(str[Bandwidth_HTTP | Bandwidth_Raw | BBC_iPlayer | BitTorrent_Cisco_EMIX | eDonkey_Data_Transfer | Evergreen_Web_ICQ_Jul_17_Send_Message | Facebook | Flash_Enterprise | HTTPS_Simulated_Enterprise])): (Read only) All available application library flows. - ConfiguredFlows (list(str[Bandwidth_HTTP | Bandwidth_Raw | BBC_iPlayer | BitTorrent_Cisco_EMIX | eDonkey_Data_Transfer | Evergreen_Web_ICQ_Jul_17_Send_Message | Facebook | Flash_Enterprise | HTTPS_Simulated_Enterprise])): Configured application library flows within profile. - - EnablePerIPStats (bool): Enable Per IP Stats. When true then Per IP statistic drilldown is available. + - EnablePerIPStats (bool): Enable Per IP Stats. When true, the Per IP statistic drilldown is available. - ObjectiveDistribution (str(applyFullObjectiveToEachPort | splitObjectiveEvenlyAmongPorts)): Objective distribution value. - - ObjectiveType (str(simulatedUsers | throughputGbps | throughputKbps | throughputMbps)): The objective type of the test.A Test Objective is the way the user sets the actual rate of the Application Library Traffic transmission. - - ObjectiveValue (number): The absolute value of either simulated users or throughput in its measure unit. - - TrafficState (str(Configured | Interim | Running | Unconfigured)): (Read only) A read-only field which indicates the current state of the traffic item. + - ObjectiveType (str(simulatedUsers | throughputGbps | throughputKbps | throughputMbps)): The objective type of the test. A Test Objective is the way the user sets the actual rate of the Application Library Traffic transmission. + - ObjectiveValue (number): The absolute value of either simulated users or throughput in its unit of measurement. + - TrafficState (str(Configured | Interim | Running | Unconfigured)): (Read only) A read-only field that indicates the current state of the traffic item. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/configelement.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/configelement.py index 0d751c125..bc89595c4 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/configelement.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/configelement.py @@ -41,13 +41,17 @@ class ConfigElement(Base): "EnableDisparityError": "enableDisparityError", "EncapsulationName": "encapsulationName", "EndpointSetId": "endpointSetId", + "PacketFrameSize": "packetFrameSize", + "PacketPayloadOffset": "packetPayloadOffset", + "PacketPayloadSize": "packetPayloadSize", + "PreambleCustomData": "preambleCustomData", "PreambleCustomSize": "preambleCustomSize", "PreambleFrameSizeMode": "preambleFrameSizeMode", } _SDM_ENUM_MAP = { "crc": ["badCrc", "goodCrc"], "destinationMacMode": ["arp", "manual"], - "preambleFrameSizeMode": ["auto", "custom"], + "preambleFrameSizeMode": ["auto", "custom", "customBytes"], } def __init__(self, parent, list_op=False): @@ -278,6 +282,51 @@ def EndpointSetId(self): """ return self._get_attribute(self._SDM_ATT_MAP["EndpointSetId"]) + @property + def PacketFrameSize(self): + # type: () -> int + """ + Returns + ------- + - number: Packet Frame Size(bytes) + """ + return self._get_attribute(self._SDM_ATT_MAP["PacketFrameSize"]) + + @property + def PacketPayloadOffset(self): + # type: () -> int + """ + Returns + ------- + - number: Packet payload offset + """ + return self._get_attribute(self._SDM_ATT_MAP["PacketPayloadOffset"]) + + @property + def PacketPayloadSize(self): + # type: () -> int + """ + Returns + ------- + - number: Packet Payload size(bits) + """ + return self._get_attribute(self._SDM_ATT_MAP["PacketPayloadSize"]) + + @property + def PreambleCustomData(self): + # type: () -> int + """ + Returns + ------- + - number: Indicates the customized preamble of the frame. Provide space separated hexadecimal bytes. + """ + return self._get_attribute(self._SDM_ATT_MAP["PreambleCustomData"]) + + @PreambleCustomData.setter + def PreambleCustomData(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["PreambleCustomData"], value) + @property def PreambleCustomSize(self): # type: () -> int @@ -299,7 +348,7 @@ def PreambleFrameSizeMode(self): """ Returns ------- - - str(auto | custom): The preamble size to synchronize sender and receiver of the configured encapsulation set. + - str(auto | custom | customBytes): The preamble size to synchronize sender and receiver of the configured encapsulation set. """ return self._get_attribute(self._SDM_ATT_MAP["PreambleFrameSizeMode"]) @@ -313,10 +362,11 @@ def update( Crc=None, DestinationMacMode=None, EnableDisparityError=None, + PreambleCustomData=None, PreambleCustomSize=None, PreambleFrameSizeMode=None, ): - # type: (str, str, bool, int, str) -> ConfigElement + # type: (str, str, bool, int, int, str) -> ConfigElement """Updates configElement resource on the server. Args @@ -324,8 +374,9 @@ def update( - Crc (str(badCrc | goodCrc)): The Cyclic Redundancy Check frame of the configured encapsulation set. - DestinationMacMode (str(arp | manual)): The destination MAC address that is to be configured. - EnableDisparityError (bool): If true, enables disparity error + - PreambleCustomData (number): Indicates the customized preamble of the frame. Provide space separated hexadecimal bytes. - PreambleCustomSize (number): Indicates the customized preamble size of the frame. - - PreambleFrameSizeMode (str(auto | custom)): The preamble size to synchronize sender and receiver of the configured encapsulation set. + - PreambleFrameSizeMode (str(auto | custom | customBytes)): The preamble size to synchronize sender and receiver of the configured encapsulation set. Raises ------ @@ -338,10 +389,11 @@ def add( Crc=None, DestinationMacMode=None, EnableDisparityError=None, + PreambleCustomData=None, PreambleCustomSize=None, PreambleFrameSizeMode=None, ): - # type: (str, str, bool, int, str) -> ConfigElement + # type: (str, str, bool, int, int, str) -> ConfigElement """Adds a new configElement resource on the json, only valid with batch add utility Args @@ -349,8 +401,9 @@ def add( - Crc (str(badCrc | goodCrc)): The Cyclic Redundancy Check frame of the configured encapsulation set. - DestinationMacMode (str(arp | manual)): The destination MAC address that is to be configured. - EnableDisparityError (bool): If true, enables disparity error + - PreambleCustomData (number): Indicates the customized preamble of the frame. Provide space separated hexadecimal bytes. - PreambleCustomSize (number): Indicates the customized preamble size of the frame. - - PreambleFrameSizeMode (str(auto | custom)): The preamble size to synchronize sender and receiver of the configured encapsulation set. + - PreambleFrameSizeMode (str(auto | custom | customBytes)): The preamble size to synchronize sender and receiver of the configured encapsulation set. Returns ------- @@ -369,10 +422,14 @@ def find( EnableDisparityError=None, EncapsulationName=None, EndpointSetId=None, + PacketFrameSize=None, + PacketPayloadOffset=None, + PacketPayloadSize=None, + PreambleCustomData=None, PreambleCustomSize=None, PreambleFrameSizeMode=None, ): - # type: (str, str, bool, str, int, int, str) -> ConfigElement + # type: (str, str, bool, str, int, int, int, int, int, int, str) -> ConfigElement """Finds and retrieves configElement resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve configElement resources from the server. @@ -386,8 +443,12 @@ def find( - EnableDisparityError (bool): If true, enables disparity error - EncapsulationName (str): Indicates the name of the encapsulation set. - EndpointSetId (number): Indicates the identification of the endpoint set. + - PacketFrameSize (number): Packet Frame Size(bytes) + - PacketPayloadOffset (number): Packet payload offset + - PacketPayloadSize (number): Packet Payload size(bits) + - PreambleCustomData (number): Indicates the customized preamble of the frame. Provide space separated hexadecimal bytes. - PreambleCustomSize (number): Indicates the customized preamble size of the frame. - - PreambleFrameSizeMode (str(auto | custom)): The preamble size to synchronize sender and receiver of the configured encapsulation set. + - PreambleFrameSizeMode (str(auto | custom | customBytes)): The preamble size to synchronize sender and receiver of the configured encapsulation set. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/MacsecHw_template.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/MacsecHw_template.py index 69c5263c8..11701529b 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/MacsecHw_template.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/MacsecHw_template.py @@ -6,20 +6,31 @@ class MacsecHw(Base): __slots__ = () _SDM_NAME = "MacsecHw" _SDM_ATT_MAP = { - "MetadataScIndex": "MacsecHw.secTag.metadata.scIndex-1", - "MetadataConfEnabled": "MacsecHw.secTag.metadata.confEnabled-2", - "MetadataBadIcv": "MacsecHw.secTag.metadata.badIcv-3", - "TciVer": "MacsecHw.secTag.tci.ver-4", - "TciEs": "MacsecHw.secTag.tci.es-5", - "TciSc": "MacsecHw.secTag.tci.sc-6", - "TciScb": "MacsecHw.secTag.tci.scb-7", - "TciE": "MacsecHw.secTag.tci.e-8", - "TciC": "MacsecHw.secTag.tci.c-9", - "SecTagAn": "MacsecHw.secTag.an-10", - "SecTagSl": "MacsecHw.secTag.sl-11", - "SecTagPn": "MacsecHw.secTag.pn-12", - "SciSysid": "MacsecHw.secTag.sci.sysid-13", - "SciPortid": "MacsecHw.secTag.sci.portid-14", + "MetadataScIndex": "MacsecHw.header.secTag.metadata.scIndex-1", + "MetadataConfEnabled": "MacsecHw.header.secTag.metadata.confEnabled-2", + "MetadataBadIcv": "MacsecHw.header.secTag.metadata.badIcv-3", + "TciVer": "MacsecHw.header.secTag.tci.ver-4", + "TciEs": "MacsecHw.header.secTag.tci.es-5", + "TciSc": "MacsecHw.header.secTag.tci.sc-6", + "TciScb": "MacsecHw.header.secTag.tci.scb-7", + "TciE": "MacsecHw.header.secTag.tci.e-8", + "TciC": "MacsecHw.header.secTag.tci.c-9", + "SecTagAn": "MacsecHw.header.secTag.an-10", + "SecTagSl": "MacsecHw.header.secTag.sl-11", + "SecTagPn": "MacsecHw.header.secTag.pn-12", + "SciSysid": "MacsecHw.header.secTag.sci.sysid-13", + "SciPortid": "MacsecHw.header.secTag.sci.portid-14", + "LagMemberPortMetadataLagMemberPortId": "MacsecHw.header.lagMemberPortsMetadata.lagMemberPortMetadata.lagMemberPortId-15", + "LagMemberPortMetadataScIndex": "MacsecHw.header.lagMemberPortsMetadata.lagMemberPortMetadata.scIndex-16", + "LagMemberPortMetadataConfEnabled": "MacsecHw.header.lagMemberPortsMetadata.lagMemberPortMetadata.confEnabled-17", + "LagmemberportmetadataTciVer": "MacsecHw.header.lagMemberPortsMetadata.lagMemberPortMetadata.tci.ver-18", + "LagmemberportmetadataTciEs": "MacsecHw.header.lagMemberPortsMetadata.lagMemberPortMetadata.tci.es-19", + "LagmemberportmetadataTciSc": "MacsecHw.header.lagMemberPortsMetadata.lagMemberPortMetadata.tci.sc-20", + "LagmemberportmetadataTciScb": "MacsecHw.header.lagMemberPortsMetadata.lagMemberPortMetadata.tci.scb-21", + "LagmemberportmetadataTciE": "MacsecHw.header.lagMemberPortsMetadata.lagMemberPortMetadata.tci.e-22", + "LagmemberportmetadataTciC": "MacsecHw.header.lagMemberPortsMetadata.lagMemberPortMetadata.tci.c-23", + "LagmemberportmetadataSciSysid": "MacsecHw.header.lagMemberPortsMetadata.lagMemberPortMetadata.sci.sysid-24", + "LagmemberportmetadataSciPortid": "MacsecHw.header.lagMemberPortsMetadata.lagMemberPortMetadata.sci.portid-25", } def __init__(self, parent, list_op=False): @@ -192,5 +203,160 @@ def SciPortid(self): return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["SciPortid"])) + @property + def LagMemberPortMetadataLagMemberPortId(self): + """ + Display Name: LAG Member Port Id + Default Value: 0 + Value Format: decimal + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, + self._get_attribute( + self._SDM_ATT_MAP["LagMemberPortMetadataLagMemberPortId"] + ), + ) + + @property + def LagMemberPortMetadataScIndex(self): + """ + Display Name: Secure Channel Index + Default Value: 0 + Value Format: decimal + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["LagMemberPortMetadataScIndex"]) + ) + + @property + def LagMemberPortMetadataConfEnabled(self): + """ + Display Name: Confidentiality Enabled + Default Value: 1 + Value Format: decimal + Available enum values: False, 0, True, 1 + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, + self._get_attribute(self._SDM_ATT_MAP["LagMemberPortMetadataConfEnabled"]), + ) + + @property + def LagmemberportmetadataTciVer(self): + """ + Display Name: Version + Default Value: 0 + Value Format: decimal + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["LagmemberportmetadataTciVer"]) + ) + + @property + def LagmemberportmetadataTciEs(self): + """ + Display Name: End Station (ES) bit + Default Value: 1 + Value Format: decimal + Available enum values: Not Set, 0, Set, 1 + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["LagmemberportmetadataTciEs"]) + ) + + @property + def LagmemberportmetadataTciSc(self): + """ + Display Name: Secure Channel (SC) bit + Default Value: 1 + Value Format: decimal + Available enum values: Not Set, 0, Set, 1 + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["LagmemberportmetadataTciSc"]) + ) + + @property + def LagmemberportmetadataTciScb(self): + """ + Display Name: Single Copy Broadcast (SCB) bit + Default Value: 0 + Value Format: decimal + Available enum values: Not Set, 0, Set, 1 + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["LagmemberportmetadataTciScb"]) + ) + + @property + def LagmemberportmetadataTciE(self): + """ + Display Name: Encryption (E) bit + Default Value: 0 + Value Format: decimal + Available enum values: Not Set, 0, Set, 1 + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["LagmemberportmetadataTciE"]) + ) + + @property + def LagmemberportmetadataTciC(self): + """ + Display Name: Changed Text (C) bit + Default Value: 0 + Value Format: decimal + Available enum values: Not Set, 0, Set, 1 + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["LagmemberportmetadataTciC"]) + ) + + @property + def LagmemberportmetadataSciSysid(self): + """ + Display Name: System Identifier + Default Value: 00:11:01:00:00:01 + Value Format: mAC + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, + self._get_attribute(self._SDM_ATT_MAP["LagmemberportmetadataSciSysid"]), + ) + + @property + def LagmemberportmetadataSciPortid(self): + """ + Display Name: Port Identifier + Default Value: 1 + Value Format: decimal + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, + self._get_attribute(self._SDM_ATT_MAP["LagmemberportmetadataSciPortid"]), + ) + def add(self): return self._create(self._map_locals(self._SDM_ATT_MAP, locals())) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/field/field.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/field/field.py index 27e14b19a..4bb5563cd 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/field/field.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/field/field.py @@ -45,7 +45,10 @@ class Field(Base): "DisplayName": "displayName", "EnumValues": "enumValues", "FieldChoice": "fieldChoice", + "FieldGroupDataType": "fieldGroupDataType", "FieldGroupName": "fieldGroupName", + "FieldGroupOptional": "fieldGroupOptional", + "FieldGroupOptionalEnabled": "fieldGroupOptionalEnabled", "FieldTypeId": "fieldTypeId", "FieldValue": "fieldValue", "FixedBits": "fixedBits", @@ -222,6 +225,16 @@ def FieldChoice(self): """ return self._get_attribute(self._SDM_ATT_MAP["FieldChoice"]) + @property + def FieldGroupDataType(self): + # type: () -> str + """ + Returns + ------- + - str: A read-only field that indicates whether the sub fields are Select/Sequence + """ + return self._get_attribute(self._SDM_ATT_MAP["FieldGroupDataType"]) + @property def FieldGroupName(self): # type: () -> str @@ -232,6 +245,26 @@ def FieldGroupName(self): """ return self._get_attribute(self._SDM_ATT_MAP["FieldGroupName"]) + @property + def FieldGroupOptional(self): + # type: () -> bool + """ + Returns + ------- + - bool: A read-only field that accepts true/false to make the field optional.< + """ + return self._get_attribute(self._SDM_ATT_MAP["FieldGroupOptional"]) + + @property + def FieldGroupOptionalEnabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: A read-only field that accepts true/false to make the field optional.< + """ + return self._get_attribute(self._SDM_ATT_MAP["FieldGroupOptionalEnabled"]) + @property def FieldTypeId(self): # type: () -> str @@ -734,7 +767,10 @@ def find( DisplayName=None, EnumValues=None, FieldChoice=None, + FieldGroupDataType=None, FieldGroupName=None, + FieldGroupOptional=None, + FieldGroupOptionalEnabled=None, FieldTypeId=None, FieldValue=None, FixedBits=None, @@ -767,7 +803,7 @@ def find( ValueList=None, ValueType=None, ): - # type: (str, bool, bool, List[str], str, str, str, List[str], bool, str, str, str, str, str, bool, int, bool, str, str, str, int, int, str, bool, bool, str, bool, bool, bool, str, str, str, str, bool, bool, bool, bool, bool, str, List[str], str) -> Field + # type: (str, bool, bool, List[str], str, str, str, List[str], bool, str, str, bool, bool, str, str, str, str, bool, int, bool, str, str, str, int, int, str, bool, bool, str, bool, bool, bool, str, str, str, str, bool, bool, bool, bool, bool, str, List[str], str) -> Field """Finds and retrieves field resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve field resources from the server. @@ -785,7 +821,10 @@ def find( - DisplayName (str): It is used to get the name of the particular field as available in Packet/Qos - EnumValues (list(str)): If the field has string options, then each string is associated with a particular integer value. This attribute is used to get the mapping of integer value with the corresponding string option. - FieldChoice (bool): It is true for all the field options active in the GUI. + - FieldGroupDataType (str): A read-only field that indicates whether the sub fields are Select/Sequence - FieldGroupName (str): + - FieldGroupOptional (bool): A read-only field that accepts true/false to make the field optional.< + - FieldGroupOptionalEnabled (bool): A read-only field that accepts true/false to make the field optional.< - FieldTypeId (str): - FieldValue (str): An alphanumeric string that returns the value of the field. - FixedBits (str): Sets all the fields to a constant specified size. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/ipv6HopByHopOptions_template.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/ipv6HopByHopOptions_template.py index 6e952f8e0..9f3a5c3dd 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/ipv6HopByHopOptions_template.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/ipv6HopByHopOptions_template.py @@ -17,7 +17,69 @@ class Ipv6HopByHopOptions(Base): "PadNLength": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.padN.length-9", "PadNData": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.padN.data-10", "OptionPad1": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pad1-11", - "HeaderPad": "ipv6HopByHopOptions.header.pad-12", + "PathTracingType": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.type-12", + "PathTracingLength": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.length-13", + "Mcd1OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd1.oifId-14", + "Mcd1Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd1.oil-15", + "Mcd1Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd1.tts-16", + "Mcd2OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd2.oifId-17", + "Mcd2Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd2.oil-18", + "Mcd2Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd2.tts-19", + "Mcd3OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd3.oifId-20", + "Mcd3Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd3.oil-21", + "Mcd3Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd3.tts-22", + "Mcd4OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd4.oifId-23", + "Mcd4Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd4.oil-24", + "Mcd4Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd4.tts-25", + "Mcd5OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd5.oifId-26", + "Mcd5Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd5.oil-27", + "Mcd5Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd5.tts-28", + "Mcd6OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd6.oifId-29", + "Mcd6Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd6.oil-30", + "Mcd6Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd6.tts-31", + "Mcd7OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd7.oifId-32", + "Mcd7Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd7.oil-33", + "Mcd7Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd7.tts-34", + "Mcd8OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd8.oifId-35", + "Mcd8Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd8.oil-36", + "Mcd8Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd8.tts-37", + "Mcd9OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd9.oifId-38", + "Mcd9Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd9.oil-39", + "Mcd9Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd9.tts-40", + "Mcd10OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd10.oifId-41", + "Mcd10Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd10.oil-42", + "Mcd10Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd10.tts-43", + "Mcd11OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd11.oifId-44", + "Mcd11Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd11.oil-45", + "Mcd11Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd11.tts-46", + "Mcd12OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd12.oifId-47", + "Mcd12Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd12.oil-48", + "Mcd12Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd12.tts-49", + "Mcd13OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd13.oifId-50", + "Mcd13Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd13.oil-51", + "Mcd13Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd13.tts-52", + "Mcd14OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd14.oifId-53", + "Mcd14Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd14.oil-54", + "Mcd14Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd14.tts-55", + "Mcd15OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd15.oifId-56", + "Mcd15Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd15.oil-57", + "Mcd15Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd15.tts-58", + "Mcd16OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd16.oifId-59", + "Mcd16Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd16.oil-60", + "Mcd16Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd16.tts-61", + "Mcd17OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd17.oifId-62", + "Mcd17Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd17.oil-63", + "Mcd17Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd17.tts-64", + "Mcd18OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd18.oifId-65", + "Mcd18Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd18.oil-66", + "Mcd18Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd18.tts-67", + "Mcd19OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd19.oifId-68", + "Mcd19Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd19.oil-69", + "Mcd19Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd19.tts-70", + "Mcd20OifId": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd20.oifId-71", + "Mcd20Oil": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd20.oil-72", + "Mcd20Tts": "ipv6HopByHopOptions.header.hopByHopOptionsHeader.options.option.pathTracing.data.mcd20.tts-73", + "HeaderPad": "ipv6HopByHopOptions.header.pad-74", } def __init__(self, parent, list_op=False): @@ -74,7 +136,7 @@ def TypeAllowPacketChange(self): Display Name: Allow Packet Change Default Value: 0 Value Format: decimal - Available enum values: Option Data can change en-route, 0, Option Data cannot change en-route, 1 + Available enum values: Option Data cannot change en-route, 0, Option Data can change en-route, 1 """ from ixnetwork_restpy.multivalue import Multivalue @@ -165,6 +227,692 @@ def OptionPad1(self): return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["OptionPad1"])) + @property + def PathTracingType(self): + """ + Display Name: Option type + Default Value: 50 + Value Format: decimal + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["PathTracingType"]) + ) + + @property + def PathTracingLength(self): + """ + Display Name: Option length (octets) + Default Value: 36 + Value Format: decimal + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["PathTracingLength"]) + ) + + @property + def Mcd1OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd1OifId"])) + + @property + def Mcd1Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd1Oil"])) + + @property + def Mcd1Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd1Tts"])) + + @property + def Mcd2OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd2OifId"])) + + @property + def Mcd2Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd2Oil"])) + + @property + def Mcd2Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd2Tts"])) + + @property + def Mcd3OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd3OifId"])) + + @property + def Mcd3Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd3Oil"])) + + @property + def Mcd3Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd3Tts"])) + + @property + def Mcd4OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd4OifId"])) + + @property + def Mcd4Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd4Oil"])) + + @property + def Mcd4Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd4Tts"])) + + @property + def Mcd5OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd5OifId"])) + + @property + def Mcd5Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd5Oil"])) + + @property + def Mcd5Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd5Tts"])) + + @property + def Mcd6OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd6OifId"])) + + @property + def Mcd6Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd6Oil"])) + + @property + def Mcd6Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd6Tts"])) + + @property + def Mcd7OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd7OifId"])) + + @property + def Mcd7Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd7Oil"])) + + @property + def Mcd7Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd7Tts"])) + + @property + def Mcd8OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd8OifId"])) + + @property + def Mcd8Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd8Oil"])) + + @property + def Mcd8Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd8Tts"])) + + @property + def Mcd9OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd9OifId"])) + + @property + def Mcd9Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd9Oil"])) + + @property + def Mcd9Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd9Tts"])) + + @property + def Mcd10OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd10OifId"])) + + @property + def Mcd10Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd10Oil"])) + + @property + def Mcd10Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd10Tts"])) + + @property + def Mcd11OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd11OifId"])) + + @property + def Mcd11Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd11Oil"])) + + @property + def Mcd11Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd11Tts"])) + + @property + def Mcd12OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd12OifId"])) + + @property + def Mcd12Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd12Oil"])) + + @property + def Mcd12Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd12Tts"])) + + @property + def Mcd13OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd13OifId"])) + + @property + def Mcd13Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd13Oil"])) + + @property + def Mcd13Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd13Tts"])) + + @property + def Mcd14OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd14OifId"])) + + @property + def Mcd14Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd14Oil"])) + + @property + def Mcd14Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd14Tts"])) + + @property + def Mcd15OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd15OifId"])) + + @property + def Mcd15Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd15Oil"])) + + @property + def Mcd15Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd15Tts"])) + + @property + def Mcd16OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd16OifId"])) + + @property + def Mcd16Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd16Oil"])) + + @property + def Mcd16Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd16Tts"])) + + @property + def Mcd17OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd17OifId"])) + + @property + def Mcd17Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd17Oil"])) + + @property + def Mcd17Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd17Tts"])) + + @property + def Mcd18OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd18OifId"])) + + @property + def Mcd18Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd18Oil"])) + + @property + def Mcd18Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd18Tts"])) + + @property + def Mcd19OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd19OifId"])) + + @property + def Mcd19Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd19Oil"])) + + @property + def Mcd19Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd19Tts"])) + + @property + def Mcd20OifId(self): + """ + Display Name: Outgoing Interface ID + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd20OifId"])) + + @property + def Mcd20Oil(self): + """ + Display Name: Outgoing Interface Load + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd20Oil"])) + + @property + def Mcd20Tts(self): + """ + Display Name: Truncated Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP["Mcd20Tts"])) + @property def HeaderPad(self): """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/ipv6RoutingType4_template.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/ipv6RoutingType4_template.py index c82bccb0a..8dbbd1cf0 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/ipv6RoutingType4_template.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/configelement/stack/ipv6RoutingType4_template.py @@ -53,9 +53,16 @@ class Ipv6RoutingType4(Base): "Sripv6OpaqueContainerTLVTclReserved": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.sripv6OpaqueContainerTLV.tclReserved-45", "Sripv6OpaqueContainerTLVTclFlags": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.sripv6OpaqueContainerTLV.tclFlags-46", "Sripv6OpaqueContainerTLVTclValue": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.sripv6OpaqueContainerTLV.tclValue-47", - "Sripv6PaddingTLVTclType": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.sripv6PaddingTLV.tclType-48", - "Sripv6PaddingTLVTclLength": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.sripv6PaddingTLV.tclLength-49", - "Sripv6PaddingTLVPad": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.sripv6PaddingTLV.pad-50", + "PathTraceTLVTclType": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.pathTraceTLV.tclType-48", + "PathTraceTLVTclLength": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.pathTraceTLV.tclLength-49", + "PathTraceTLVIfId": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.pathTraceTLV.ifId-50", + "PathTraceTLVIfLd": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.pathTraceTLV.ifLd-51", + "PathTraceTLVTimeStamp": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.pathTraceTLV.timeStamp-52", + "PathTraceTLVSessionId": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.pathTraceTLV.sessionId-53", + "PathTraceTLVSequenceNo": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.pathTraceTLV.sequenceNo-54", + "Sripv6PaddingTLVTclType": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.sripv6PaddingTLV.tclType-55", + "Sripv6PaddingTLVTclLength": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.sripv6PaddingTLV.tclLength-56", + "Sripv6PaddingTLVPad": "ipv6RoutingType4.segmentRoutingHeader.srhTLVs.sripv6PaddingTLV.pad-57", } def __init__(self, parent, list_op=False): @@ -680,6 +687,97 @@ def Sripv6OpaqueContainerTLVTclValue(self): self._get_attribute(self._SDM_ATT_MAP["Sripv6OpaqueContainerTLVTclValue"]), ) + @property + def PathTraceTLVTclType(self): + """ + Display Name: Type + Default Value: 128 + Value Format: decimal + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["PathTraceTLVTclType"]) + ) + + @property + def PathTraceTLVTclLength(self): + """ + Display Name: Length + Default Value: 14 + Value Format: decimal + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["PathTraceTLVTclLength"]) + ) + + @property + def PathTraceTLVIfId(self): + """ + Display Name: Interface ID + Default Value: 0 + Value Format: decimal + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["PathTraceTLVIfId"]) + ) + + @property + def PathTraceTLVIfLd(self): + """ + Display Name: Interface Load + Default Value: 0 + Value Format: decimal + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["PathTraceTLVIfLd"]) + ) + + @property + def PathTraceTLVTimeStamp(self): + """ + Display Name: Timestamp + Default Value: 0 + Value Format: hex + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["PathTraceTLVTimeStamp"]) + ) + + @property + def PathTraceTLVSessionId(self): + """ + Display Name: Session ID + Default Value: 0 + Value Format: decimal + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["PathTraceTLVSessionId"]) + ) + + @property + def PathTraceTLVSequenceNo(self): + """ + Display Name: Sequence Number + Default Value: 0 + Value Format: decimal + """ + from ixnetwork_restpy.multivalue import Multivalue + + return Multivalue( + self, self._get_attribute(self._SDM_ATT_MAP["PathTraceTLVSequenceNo"]) + ) + @property def Sripv6PaddingTLVTclType(self): """ diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/egresstracking/fieldoffset/stack/field/field.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/egresstracking/fieldoffset/stack/field/field.py index ee3d8f09f..37fbd2483 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/egresstracking/fieldoffset/stack/field/field.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/egresstracking/fieldoffset/stack/field/field.py @@ -45,7 +45,10 @@ class Field(Base): "DisplayName": "displayName", "EnumValues": "enumValues", "FieldChoice": "fieldChoice", + "FieldGroupDataType": "fieldGroupDataType", "FieldGroupName": "fieldGroupName", + "FieldGroupOptional": "fieldGroupOptional", + "FieldGroupOptionalEnabled": "fieldGroupOptionalEnabled", "FieldTypeId": "fieldTypeId", "FieldValue": "fieldValue", "FixedBits": "fixedBits", @@ -222,6 +225,16 @@ def FieldChoice(self): """ return self._get_attribute(self._SDM_ATT_MAP["FieldChoice"]) + @property + def FieldGroupDataType(self): + # type: () -> str + """ + Returns + ------- + - str: A read-only field that indicates whether the sub fields are Select/Sequence + """ + return self._get_attribute(self._SDM_ATT_MAP["FieldGroupDataType"]) + @property def FieldGroupName(self): # type: () -> str @@ -232,6 +245,26 @@ def FieldGroupName(self): """ return self._get_attribute(self._SDM_ATT_MAP["FieldGroupName"]) + @property + def FieldGroupOptional(self): + # type: () -> bool + """ + Returns + ------- + - bool: A read-only field that accepts true/false to make the field optional.< + """ + return self._get_attribute(self._SDM_ATT_MAP["FieldGroupOptional"]) + + @property + def FieldGroupOptionalEnabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: A read-only field that accepts true/false to make the field optional.< + """ + return self._get_attribute(self._SDM_ATT_MAP["FieldGroupOptionalEnabled"]) + @property def FieldTypeId(self): # type: () -> str @@ -734,7 +767,10 @@ def find( DisplayName=None, EnumValues=None, FieldChoice=None, + FieldGroupDataType=None, FieldGroupName=None, + FieldGroupOptional=None, + FieldGroupOptionalEnabled=None, FieldTypeId=None, FieldValue=None, FixedBits=None, @@ -767,7 +803,7 @@ def find( ValueList=None, ValueType=None, ): - # type: (str, bool, bool, List[str], str, str, str, List[str], bool, str, str, str, str, str, bool, int, bool, str, str, str, int, int, str, bool, bool, str, bool, bool, bool, str, str, str, str, bool, bool, bool, bool, bool, str, List[str], str) -> Field + # type: (str, bool, bool, List[str], str, str, str, List[str], bool, str, str, bool, bool, str, str, str, str, bool, int, bool, str, str, str, int, int, str, bool, bool, str, bool, bool, bool, str, str, str, str, bool, bool, bool, bool, bool, str, List[str], str) -> Field """Finds and retrieves field resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve field resources from the server. @@ -785,7 +821,10 @@ def find( - DisplayName (str): It is used to get the name of the particular field as available in Packet/Qos - EnumValues (list(str)): If the field has string options, then each string is associated with a particular integer value. This attribute is used to get the mapping of integer value with the corresponding string option. - FieldChoice (bool): It is true for all the field options active in the GUI. + - FieldGroupDataType (str): A read-only field that indicates whether the sub fields are Select/Sequence - FieldGroupName (str): + - FieldGroupOptional (bool): A read-only field that accepts true/false to make the field optional.< + - FieldGroupOptionalEnabled (bool): A read-only field that accepts true/false to make the field optional.< - FieldTypeId (str): - FieldValue (str): An alphanumeric string that returns the value of the field. - FixedBits (str): Sets all the fields to a constant specified size. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/highlevelstream/highlevelstream.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/highlevelstream/highlevelstream.py index 1de372016..7b37d7a7c 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/highlevelstream/highlevelstream.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/highlevelstream/highlevelstream.py @@ -49,6 +49,7 @@ class HighLevelStream(Base): "Name": "name", "OverSubscribed": "overSubscribed", "Pause": "pause", + "PreambleCustomData": "preambleCustomData", "PreambleCustomSize": "preambleCustomSize", "PreambleFrameSizeMode": "preambleFrameSizeMode", "RxPortIds": "rxPortIds", @@ -61,7 +62,7 @@ class HighLevelStream(Base): _SDM_ENUM_MAP = { "crc": ["badCrc", "goodCrc"], "destinationMacMode": ["arp", "manual"], - "preambleFrameSizeMode": ["auto", "custom"], + "preambleFrameSizeMode": ["auto", "custom", "customBytes"], } def __init__(self, parent, list_op=False): @@ -401,6 +402,21 @@ def Pause(self, value): # type: (bool) -> None self._set_attribute(self._SDM_ATT_MAP["Pause"], value) + @property + def PreambleCustomData(self): + # type: () -> str + """ + Returns + ------- + - str: Customizes the preamble of the frame. Provide space separated hexadecimal bytes. + """ + return self._get_attribute(self._SDM_ATT_MAP["PreambleCustomData"]) + + @PreambleCustomData.setter + def PreambleCustomData(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["PreambleCustomData"], value) + @property def PreambleCustomSize(self): # type: () -> int @@ -422,7 +438,7 @@ def PreambleFrameSizeMode(self): """ Returns ------- - - str(auto | custom): The starting size of the frame. + - str(auto | custom | customBytes): The starting size of the frame. """ return self._get_attribute(self._SDM_ATT_MAP["PreambleFrameSizeMode"]) @@ -513,13 +529,14 @@ def update( Enabled=None, Name=None, Pause=None, + PreambleCustomData=None, PreambleCustomSize=None, PreambleFrameSizeMode=None, RxPortIds=None, Suspend=None, TxPortId=None, ): - # type: (str, str, bool, str, bool, int, str, List[str], bool, str) -> HighLevelStream + # type: (str, str, bool, str, bool, str, int, str, List[str], bool, str) -> HighLevelStream """Updates highLevelStream resource on the server. Args @@ -529,8 +546,9 @@ def update( - Enabled (bool): - Name (str): An alphanumeric string that returns the name of the field. - Pause (bool): If true then pause is enabled. + - PreambleCustomData (str): Customizes the preamble of the frame. Provide space separated hexadecimal bytes. - PreambleCustomSize (number): >Customizes the preamble size of the frame. - - PreambleFrameSizeMode (str(auto | custom)): The starting size of the frame. + - PreambleFrameSizeMode (str(auto | custom | customBytes)): The starting size of the frame. - RxPortIds (list(str[None | /api/v1/sessions/1/ixnetwork/lag | /api/v1/sessions/1/ixnetwork/vport])): A list of virtual ports that are the receiving ports - Suspend (bool): Suspends all traffic on this high level stream. - TxPortId (str(None | /api/v1/sessions/1/ixnetwork/lag | /api/v1/sessions/1/ixnetwork/vport)): The virtual port that is the transmitting port. @@ -548,13 +566,14 @@ def add( Enabled=None, Name=None, Pause=None, + PreambleCustomData=None, PreambleCustomSize=None, PreambleFrameSizeMode=None, RxPortIds=None, Suspend=None, TxPortId=None, ): - # type: (str, str, bool, str, bool, int, str, List[str], bool, str) -> HighLevelStream + # type: (str, str, bool, str, bool, str, int, str, List[str], bool, str) -> HighLevelStream """Adds a new highLevelStream resource on the json, only valid with batch add utility Args @@ -564,8 +583,9 @@ def add( - Enabled (bool): - Name (str): An alphanumeric string that returns the name of the field. - Pause (bool): If true then pause is enabled. + - PreambleCustomData (str): Customizes the preamble of the frame. Provide space separated hexadecimal bytes. - PreambleCustomSize (number): >Customizes the preamble size of the frame. - - PreambleFrameSizeMode (str(auto | custom)): The starting size of the frame. + - PreambleFrameSizeMode (str(auto | custom | customBytes)): The starting size of the frame. - RxPortIds (list(str[None | /api/v1/sessions/1/ixnetwork/lag | /api/v1/sessions/1/ixnetwork/vport])): A list of virtual ports that are the receiving ports - Suspend (bool): Suspends all traffic on this high level stream. - TxPortId (str(None | /api/v1/sessions/1/ixnetwork/lag | /api/v1/sessions/1/ixnetwork/vport)): The virtual port that is the transmitting port. @@ -595,6 +615,7 @@ def find( Name=None, OverSubscribed=None, Pause=None, + PreambleCustomData=None, PreambleCustomSize=None, PreambleFrameSizeMode=None, RxPortIds=None, @@ -625,8 +646,9 @@ def find( - Name (str): An alphanumeric string that returns the name of the field. - OverSubscribed (bool): If true, the rate is oversubscribed. - Pause (bool): If true then pause is enabled. + - PreambleCustomData (str): Customizes the preamble of the frame. Provide space separated hexadecimal bytes. - PreambleCustomSize (number): >Customizes the preamble size of the frame. - - PreambleFrameSizeMode (str(auto | custom)): The starting size of the frame. + - PreambleFrameSizeMode (str(auto | custom | customBytes)): The starting size of the frame. - RxPortIds (list(str[None | /api/v1/sessions/1/ixnetwork/lag | /api/v1/sessions/1/ixnetwork/vport])): A list of virtual ports that are the receiving ports - RxPortNames (list(str)): A list of names from the receiving virtual ports. - State (str): (Read only) Denotes the current state of the stream. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/highlevelstream/stack/field/field.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/highlevelstream/stack/field/field.py index 018b3e87d..127686a53 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/highlevelstream/stack/field/field.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/highlevelstream/stack/field/field.py @@ -45,7 +45,10 @@ class Field(Base): "DisplayName": "displayName", "EnumValues": "enumValues", "FieldChoice": "fieldChoice", + "FieldGroupDataType": "fieldGroupDataType", "FieldGroupName": "fieldGroupName", + "FieldGroupOptional": "fieldGroupOptional", + "FieldGroupOptionalEnabled": "fieldGroupOptionalEnabled", "FieldTypeId": "fieldTypeId", "FieldValue": "fieldValue", "FixedBits": "fixedBits", @@ -222,6 +225,16 @@ def FieldChoice(self): """ return self._get_attribute(self._SDM_ATT_MAP["FieldChoice"]) + @property + def FieldGroupDataType(self): + # type: () -> str + """ + Returns + ------- + - str: A read-only field that indicates whether the sub fields are Select/Sequence + """ + return self._get_attribute(self._SDM_ATT_MAP["FieldGroupDataType"]) + @property def FieldGroupName(self): # type: () -> str @@ -232,6 +245,26 @@ def FieldGroupName(self): """ return self._get_attribute(self._SDM_ATT_MAP["FieldGroupName"]) + @property + def FieldGroupOptional(self): + # type: () -> bool + """ + Returns + ------- + - bool: A read-only field that accepts true/false to make the field optional.< + """ + return self._get_attribute(self._SDM_ATT_MAP["FieldGroupOptional"]) + + @property + def FieldGroupOptionalEnabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: A read-only field that accepts true/false to make the field optional.< + """ + return self._get_attribute(self._SDM_ATT_MAP["FieldGroupOptionalEnabled"]) + @property def FieldTypeId(self): # type: () -> str @@ -734,7 +767,10 @@ def find( DisplayName=None, EnumValues=None, FieldChoice=None, + FieldGroupDataType=None, FieldGroupName=None, + FieldGroupOptional=None, + FieldGroupOptionalEnabled=None, FieldTypeId=None, FieldValue=None, FixedBits=None, @@ -767,7 +803,7 @@ def find( ValueList=None, ValueType=None, ): - # type: (str, bool, bool, List[str], str, str, str, List[str], bool, str, str, str, str, str, bool, int, bool, str, str, str, int, int, str, bool, bool, str, bool, bool, bool, str, str, str, str, bool, bool, bool, bool, bool, str, List[str], str) -> Field + # type: (str, bool, bool, List[str], str, str, str, List[str], bool, str, str, bool, bool, str, str, str, str, bool, int, bool, str, str, str, int, int, str, bool, bool, str, bool, bool, bool, str, str, str, str, bool, bool, bool, bool, bool, str, List[str], str) -> Field """Finds and retrieves field resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve field resources from the server. @@ -785,7 +821,10 @@ def find( - DisplayName (str): It is used to get the name of the particular field as available in Packet/Qos - EnumValues (list(str)): If the field has string options, then each string is associated with a particular integer value. This attribute is used to get the mapping of integer value with the corresponding string option. - FieldChoice (bool): It is true for all the field options active in the GUI. + - FieldGroupDataType (str): A read-only field that indicates whether the sub fields are Select/Sequence - FieldGroupName (str): + - FieldGroupOptional (bool): A read-only field that accepts true/false to make the field optional.< + - FieldGroupOptionalEnabled (bool): A read-only field that accepts true/false to make the field optional.< - FieldTypeId (str): - FieldValue (str): An alphanumeric string that returns the value of the field. - FixedBits (str): Sets all the fields to a constant specified size. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/tracking/egress/fieldoffset/stack/field/field.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/tracking/egress/fieldoffset/stack/field/field.py index ee3d8f09f..37fbd2483 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/tracking/egress/fieldoffset/stack/field/field.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/traffic/trafficitem/tracking/egress/fieldoffset/stack/field/field.py @@ -45,7 +45,10 @@ class Field(Base): "DisplayName": "displayName", "EnumValues": "enumValues", "FieldChoice": "fieldChoice", + "FieldGroupDataType": "fieldGroupDataType", "FieldGroupName": "fieldGroupName", + "FieldGroupOptional": "fieldGroupOptional", + "FieldGroupOptionalEnabled": "fieldGroupOptionalEnabled", "FieldTypeId": "fieldTypeId", "FieldValue": "fieldValue", "FixedBits": "fixedBits", @@ -222,6 +225,16 @@ def FieldChoice(self): """ return self._get_attribute(self._SDM_ATT_MAP["FieldChoice"]) + @property + def FieldGroupDataType(self): + # type: () -> str + """ + Returns + ------- + - str: A read-only field that indicates whether the sub fields are Select/Sequence + """ + return self._get_attribute(self._SDM_ATT_MAP["FieldGroupDataType"]) + @property def FieldGroupName(self): # type: () -> str @@ -232,6 +245,26 @@ def FieldGroupName(self): """ return self._get_attribute(self._SDM_ATT_MAP["FieldGroupName"]) + @property + def FieldGroupOptional(self): + # type: () -> bool + """ + Returns + ------- + - bool: A read-only field that accepts true/false to make the field optional.< + """ + return self._get_attribute(self._SDM_ATT_MAP["FieldGroupOptional"]) + + @property + def FieldGroupOptionalEnabled(self): + # type: () -> bool + """ + Returns + ------- + - bool: A read-only field that accepts true/false to make the field optional.< + """ + return self._get_attribute(self._SDM_ATT_MAP["FieldGroupOptionalEnabled"]) + @property def FieldTypeId(self): # type: () -> str @@ -734,7 +767,10 @@ def find( DisplayName=None, EnumValues=None, FieldChoice=None, + FieldGroupDataType=None, FieldGroupName=None, + FieldGroupOptional=None, + FieldGroupOptionalEnabled=None, FieldTypeId=None, FieldValue=None, FixedBits=None, @@ -767,7 +803,7 @@ def find( ValueList=None, ValueType=None, ): - # type: (str, bool, bool, List[str], str, str, str, List[str], bool, str, str, str, str, str, bool, int, bool, str, str, str, int, int, str, bool, bool, str, bool, bool, bool, str, str, str, str, bool, bool, bool, bool, bool, str, List[str], str) -> Field + # type: (str, bool, bool, List[str], str, str, str, List[str], bool, str, str, bool, bool, str, str, str, str, bool, int, bool, str, str, str, int, int, str, bool, bool, str, bool, bool, bool, str, str, str, str, bool, bool, bool, bool, bool, str, List[str], str) -> Field """Finds and retrieves field resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve field resources from the server. @@ -785,7 +821,10 @@ def find( - DisplayName (str): It is used to get the name of the particular field as available in Packet/Qos - EnumValues (list(str)): If the field has string options, then each string is associated with a particular integer value. This attribute is used to get the mapping of integer value with the corresponding string option. - FieldChoice (bool): It is true for all the field options active in the GUI. + - FieldGroupDataType (str): A read-only field that indicates whether the sub fields are Select/Sequence - FieldGroupName (str): + - FieldGroupOptional (bool): A read-only field that accepts true/false to make the field optional.< + - FieldGroupOptionalEnabled (bool): A read-only field that accepts true/false to make the field optional.< - FieldTypeId (str): - FieldValue (str): An alphanumeric string that returns the value of the field. - FixedBits (str): Sets all the fields to a constant specified size. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/capture/filter/filter.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/capture/filter/filter.py index c5b3c2884..7f980e114 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/capture/filter/filter.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/capture/filter/filter.py @@ -49,16 +49,16 @@ class Filter(Base): "captureFilterDA": ["addr1", "addr2", "anyAddr", "notAddr1", "notAddr2"], "captureFilterError": [ "errAnyFrame", - "errAnyIpTcpUdpChecksumError", - "errAnySequencekError", "errBadCRC", + "errGoodFrame", "errBadFrame", + "errAnySequencekError", "errBigSequenceError", + "errSmallSequenceError", + "errReverseSequenceError", "errDataIntegrityError", - "errGoodFrame", + "errAnyIpTcpUdpChecksumError", "errInvalidFcoeFrame", - "errReverseSequenceError", - "errSmallSequenceError", ], "captureFilterPattern": [ "anyPattern", @@ -110,7 +110,7 @@ def CaptureFilterError(self): """ Returns ------- - - str(errAnyFrame | errAnyIpTcpUdpChecksumError | errAnySequencekError | errBadCRC | errBadFrame | errBigSequenceError | errDataIntegrityError | errGoodFrame | errInvalidFcoeFrame | errReverseSequenceError | errSmallSequenceError): Applicable only when captureFilterEnable is set to true. + - str(errAnyFrame | errBadCRC | errGoodFrame | errBadFrame | errAnySequencekError | errBigSequenceError | errSmallSequenceError | errReverseSequenceError | errDataIntegrityError | errAnyIpTcpUdpChecksumError | errInvalidFcoeFrame): Applicable only when captureFilterEnable is set to true. """ return self._get_attribute(self._SDM_ATT_MAP["CaptureFilterError"]) @@ -228,7 +228,7 @@ def update( ---- - CaptureFilterDA (str(addr1 | addr2 | anyAddr | notAddr1 | notAddr2)): One of two available destination MAC addresses to filter on. Applicable only when captureFilterEnable is set to true. - CaptureFilterEnable (bool): Enables or disables the capture filter. - - CaptureFilterError (str(errAnyFrame | errAnyIpTcpUdpChecksumError | errAnySequencekError | errBadCRC | errBadFrame | errBigSequenceError | errDataIntegrityError | errGoodFrame | errInvalidFcoeFrame | errReverseSequenceError | errSmallSequenceError)): Applicable only when captureFilterEnable is set to true. + - CaptureFilterError (str(errAnyFrame | errBadCRC | errGoodFrame | errBadFrame | errAnySequencekError | errBigSequenceError | errSmallSequenceError | errReverseSequenceError | errDataIntegrityError | errAnyIpTcpUdpChecksumError | errInvalidFcoeFrame)): Applicable only when captureFilterEnable is set to true. - CaptureFilterExpressionString (str): String composed of SA1, DA1, P1, P2, optionally negated with '!', and connected with operators 'and', 'or', 'xor', 'nand' or 'nor'. (Eg: {DA1 and SA1 or !P1 and P2} ). NOTE: The 'or', 'xor', 'nand' and 'nor' operators are available only on the following load modules: XMVDC, NGY, XMSP12, LAVA(MK), Xcellon AP, Xcellon NP. - CaptureFilterFrameSizeEnable (bool): Enables or disables the frame size constraint which specifies a range of frame. - CaptureFilterFrameSizeFrom (number): Applicable only when captureFilterFrameSizeEnable is enabled. The minimum range of the size of frame to be filtered. @@ -265,7 +265,7 @@ def find( ---- - CaptureFilterDA (str(addr1 | addr2 | anyAddr | notAddr1 | notAddr2)): One of two available destination MAC addresses to filter on. Applicable only when captureFilterEnable is set to true. - CaptureFilterEnable (bool): Enables or disables the capture filter. - - CaptureFilterError (str(errAnyFrame | errAnyIpTcpUdpChecksumError | errAnySequencekError | errBadCRC | errBadFrame | errBigSequenceError | errDataIntegrityError | errGoodFrame | errInvalidFcoeFrame | errReverseSequenceError | errSmallSequenceError)): Applicable only when captureFilterEnable is set to true. + - CaptureFilterError (str(errAnyFrame | errBadCRC | errGoodFrame | errBadFrame | errAnySequencekError | errBigSequenceError | errSmallSequenceError | errReverseSequenceError | errDataIntegrityError | errAnyIpTcpUdpChecksumError | errInvalidFcoeFrame)): Applicable only when captureFilterEnable is set to true. - CaptureFilterExpressionString (str): String composed of SA1, DA1, P1, P2, optionally negated with '!', and connected with operators 'and', 'or', 'xor', 'nand' or 'nor'. (Eg: {DA1 and SA1 or !P1 and P2} ). NOTE: The 'or', 'xor', 'nand' and 'nor' operators are available only on the following load modules: XMVDC, NGY, XMSP12, LAVA(MK), Xcellon AP, Xcellon NP. - CaptureFilterFrameSizeEnable (bool): Enables or disables the frame size constraint which specifies a range of frame. - CaptureFilterFrameSizeFrom (number): Applicable only when captureFilterFrameSizeEnable is enabled. The minimum range of the size of frame to be filtered. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/capture/trigger/trigger.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/capture/trigger/trigger.py index 043ba3e9c..cd978c009 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/capture/trigger/trigger.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/capture/trigger/trigger.py @@ -49,16 +49,16 @@ class Trigger(Base): "captureTriggerDA": ["addr1", "addr2", "anyAddr", "notAddr1", "notAddr2"], "captureTriggerError": [ "errAnyFrame", - "errAnyIpTcpUdpChecksumError", - "errAnySequencekError", "errBadCRC", + "errGoodFrame", "errBadFrame", + "errAnySequencekError", "errBigSequenceError", + "errSmallSequenceError", + "errReverseSequenceError", "errDataIntegrityError", - "errGoodFrame", + "errAnyIpTcpUdpChecksumError", "errInvalidFcoeFrame", - "errReverseSequenceError", - "errSmallSequenceError", ], "captureTriggerPattern": [ "anyPattern", @@ -110,7 +110,7 @@ def CaptureTriggerError(self): """ Returns ------- - - str(errAnyFrame | errAnyIpTcpUdpChecksumError | errAnySequencekError | errBadCRC | errBadFrame | errBigSequenceError | errDataIntegrityError | errGoodFrame | errInvalidFcoeFrame | errReverseSequenceError | errSmallSequenceError): Applicable only when captureTriggerEnable is set to true. + - str(errAnyFrame | errBadCRC | errGoodFrame | errBadFrame | errAnySequencekError | errBigSequenceError | errSmallSequenceError | errReverseSequenceError | errDataIntegrityError | errAnyIpTcpUdpChecksumError | errInvalidFcoeFrame): Applicable only when captureTriggerEnable is set to true. """ return self._get_attribute(self._SDM_ATT_MAP["CaptureTriggerError"]) @@ -228,7 +228,7 @@ def update( ---- - CaptureTriggerDA (str(addr1 | addr2 | anyAddr | notAddr1 | notAddr2)): One of two available destination MAC addresses to filter on. Applicable only when captureTriggerEnable is set to true. - CaptureTriggerEnable (bool): Enables or disables the capture trigger. - - CaptureTriggerError (str(errAnyFrame | errAnyIpTcpUdpChecksumError | errAnySequencekError | errBadCRC | errBadFrame | errBigSequenceError | errDataIntegrityError | errGoodFrame | errInvalidFcoeFrame | errReverseSequenceError | errSmallSequenceError)): Applicable only when captureTriggerEnable is set to true. + - CaptureTriggerError (str(errAnyFrame | errBadCRC | errGoodFrame | errBadFrame | errAnySequencekError | errBigSequenceError | errSmallSequenceError | errReverseSequenceError | errDataIntegrityError | errAnyIpTcpUdpChecksumError | errInvalidFcoeFrame)): Applicable only when captureTriggerEnable is set to true. - CaptureTriggerExpressionString (str): String composed of SA1, DA1, P1, P2, optionally negated with '!', and connected with operators 'and', 'or', 'xor', 'nand' or 'nor'. (Eg: {DA1 and SA1 or !P1 and P2} ). NOTE: The 'or', 'xor', 'nand' and 'nor' operators are available only on the following load modules: XMVDC, NGY, XMSP12, LAVA(MK), Xcellon AP, Xcellon NP. - CaptureTriggerFrameSizeEnable (bool): Enables or disables the frame size constraint which specifies a range of frame. - CaptureTriggerFrameSizeFrom (number): Applicable only when captureTriggerFrameSizeEnable is enabled. The minimum range of the size of frame to be triggered. @@ -265,7 +265,7 @@ def find( ---- - CaptureTriggerDA (str(addr1 | addr2 | anyAddr | notAddr1 | notAddr2)): One of two available destination MAC addresses to filter on. Applicable only when captureTriggerEnable is set to true. - CaptureTriggerEnable (bool): Enables or disables the capture trigger. - - CaptureTriggerError (str(errAnyFrame | errAnyIpTcpUdpChecksumError | errAnySequencekError | errBadCRC | errBadFrame | errBigSequenceError | errDataIntegrityError | errGoodFrame | errInvalidFcoeFrame | errReverseSequenceError | errSmallSequenceError)): Applicable only when captureTriggerEnable is set to true. + - CaptureTriggerError (str(errAnyFrame | errBadCRC | errGoodFrame | errBadFrame | errAnySequencekError | errBigSequenceError | errSmallSequenceError | errReverseSequenceError | errDataIntegrityError | errAnyIpTcpUdpChecksumError | errInvalidFcoeFrame)): Applicable only when captureTriggerEnable is set to true. - CaptureTriggerExpressionString (str): String composed of SA1, DA1, P1, P2, optionally negated with '!', and connected with operators 'and', 'or', 'xor', 'nand' or 'nor'. (Eg: {DA1 and SA1 or !P1 and P2} ). NOTE: The 'or', 'xor', 'nand' and 'nor' operators are available only on the following load modules: XMVDC, NGY, XMSP12, LAVA(MK), Xcellon AP, Xcellon NP. - CaptureTriggerFrameSizeEnable (bool): Enables or disables the frame size constraint which specifies a range of frame. - CaptureTriggerFrameSizeFrom (number): Applicable only when captureTriggerFrameSizeEnable is enabled. The minimum range of the size of frame to be triggered. diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/aresoneeighthundredgiglanqddc/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/aresoneeighthundredgiglanqddc/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/aresoneeighthundredgiglanqddc/aresoneeighthundredgiglanqddc.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/aresoneeighthundredgiglanqddc/aresoneeighthundredgiglanqddc.py new file mode 100644 index 000000000..56b7481e6 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/aresoneeighthundredgiglanqddc/aresoneeighthundredgiglanqddc.py @@ -0,0 +1,584 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class AresOneEightHundredGigLanQddC(Base): + """ + The AresOneEightHundredGigLanQddC class encapsulates a required aresOneEightHundredGigLanQddC resource which will be retrieved from the server every time the property is accessed. + """ + + __slots__ = () + _SDM_NAME = "aresOneEightHundredGigLanQddC" + _SDM_ATT_MAP = { + "AutoInstrumentation": "autoInstrumentation", + "AvailableSpeeds": "availableSpeeds", + "BadBlocksNumber": "badBlocksNumber", + "CanModifySpeed": "canModifySpeed", + "CanSetMultipleSpeeds": "canSetMultipleSpeeds", + "EnableAutoNegotiation": "enableAutoNegotiation", + "EnablePPM": "enablePPM", + "EnabledFlowControl": "enabledFlowControl", + "FlowControlDirectedAddress": "flowControlDirectedAddress", + "GoodBlocksNumber": "goodBlocksNumber", + "LaserOn": "laserOn", + "LinkTraining": "linkTraining", + "LoopContinuously": "loopContinuously", + "LoopCountNumber": "loopCountNumber", + "Loopback": "loopback", + "LoopbackMode": "loopbackMode", + "Ppm": "ppm", + "SelectedSpeeds": "selectedSpeeds", + "SendSetsMode": "sendSetsMode", + "Speed": "speed", + "StartErrorInsertion": "startErrorInsertion", + "TxIgnoreRxLinkFaults": "txIgnoreRxLinkFaults", + "TypeAOrderedSets": "typeAOrderedSets", + "TypeBOrderedSets": "typeBOrderedSets", + } + _SDM_ENUM_MAP = { + "autoInstrumentation": ["endOfFrame", "floating"], + "loopbackMode": ["none", "internalLoopback"], + "sendSetsMode": ["alternate", "typeAOnly", "typeBOnly"], + "speed": ["speed100g", "speed200g", "speed400g", "speed800g"], + "typeAOrderedSets": ["localFault", "remoteFault"], + "typeBOrderedSets": ["localFault", "remoteFault"], + } + + def __init__(self, parent, list_op=False): + super(AresOneEightHundredGigLanQddC, self).__init__(parent, list_op) + + @property + def Fcoe(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.vport.l1config.aresoneeighthundredgiglanqddc.fcoe.fcoe.Fcoe): An instance of the Fcoe class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.vport.l1config.aresoneeighthundredgiglanqddc.fcoe.fcoe import ( + Fcoe, + ) + + if len(self._object_properties) > 0: + if self._properties.get("Fcoe", None) is not None: + return self._properties.get("Fcoe") + return Fcoe(self)._select() + + @property + def AutoInstrumentation(self): + # type: () -> str + """ + Returns + ------- + - str(endOfFrame | floating): The auto instrumentation mode. + """ + return self._get_attribute(self._SDM_ATT_MAP["AutoInstrumentation"]) + + @AutoInstrumentation.setter + def AutoInstrumentation(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["AutoInstrumentation"], value) + + @property + def AvailableSpeeds(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str[speed100g | speed200g | speed400g | speed800g]): Which speeds are available for the current media and AN settings. + """ + return self._get_attribute(self._SDM_ATT_MAP["AvailableSpeeds"]) + + @property + def BadBlocksNumber(self): + # type: () -> int + """ + Returns + ------- + - number: + """ + return self._get_attribute(self._SDM_ATT_MAP["BadBlocksNumber"]) + + @BadBlocksNumber.setter + def BadBlocksNumber(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["BadBlocksNumber"], value) + + @property + def CanModifySpeed(self): + # type: () -> bool + """ + Returns + ------- + - bool: Returns true/false depending upon if the port can change speed for the current media and AN settings. + """ + return self._get_attribute(self._SDM_ATT_MAP["CanModifySpeed"]) + + @property + def CanSetMultipleSpeeds(self): + # type: () -> bool + """ + Returns + ------- + - bool: Can this port selectmultiple speeds for the current media and AN settings. + """ + return self._get_attribute(self._SDM_ATT_MAP["CanSetMultipleSpeeds"]) + + @property + def EnableAutoNegotiation(self): + # type: () -> bool + """ + Returns + ------- + - bool: + """ + return self._get_attribute(self._SDM_ATT_MAP["EnableAutoNegotiation"]) + + @EnableAutoNegotiation.setter + def EnableAutoNegotiation(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["EnableAutoNegotiation"], value) + + @property + def EnablePPM(self): + # type: () -> bool + """ + Returns + ------- + - bool: If true, enables the portsppm. + """ + return self._get_attribute(self._SDM_ATT_MAP["EnablePPM"]) + + @EnablePPM.setter + def EnablePPM(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["EnablePPM"], value) + + @property + def EnabledFlowControl(self): + # type: () -> bool + """ + Returns + ------- + - bool: If true, enables the port's MAC flow control mechanisms to listen for a directed address pause message. + """ + return self._get_attribute(self._SDM_ATT_MAP["EnabledFlowControl"]) + + @EnabledFlowControl.setter + def EnabledFlowControl(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["EnabledFlowControl"], value) + + @property + def FlowControlDirectedAddress(self): + # type: () -> str + """ + Returns + ------- + - str: The 48-bit MAC address that the port listens on for a directed pause. + """ + return self._get_attribute(self._SDM_ATT_MAP["FlowControlDirectedAddress"]) + + @FlowControlDirectedAddress.setter + def FlowControlDirectedAddress(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["FlowControlDirectedAddress"], value) + + @property + def GoodBlocksNumber(self): + # type: () -> int + """ + Returns + ------- + - number: + """ + return self._get_attribute(self._SDM_ATT_MAP["GoodBlocksNumber"]) + + @GoodBlocksNumber.setter + def GoodBlocksNumber(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["GoodBlocksNumber"], value) + + @property + def LaserOn(self): + # type: () -> bool + """ + Returns + ------- + - bool: + """ + return self._get_attribute(self._SDM_ATT_MAP["LaserOn"]) + + @LaserOn.setter + def LaserOn(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["LaserOn"], value) + + @property + def LinkTraining(self): + # type: () -> bool + """ + Returns + ------- + - bool: + """ + return self._get_attribute(self._SDM_ATT_MAP["LinkTraining"]) + + @LinkTraining.setter + def LinkTraining(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["LinkTraining"], value) + + @property + def LoopContinuously(self): + # type: () -> bool + """ + Returns + ------- + - bool: + """ + return self._get_attribute(self._SDM_ATT_MAP["LoopContinuously"]) + + @LoopContinuously.setter + def LoopContinuously(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["LoopContinuously"], value) + + @property + def LoopCountNumber(self): + # type: () -> int + """ + Returns + ------- + - number: + """ + return self._get_attribute(self._SDM_ATT_MAP["LoopCountNumber"]) + + @LoopCountNumber.setter + def LoopCountNumber(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["LoopCountNumber"], value) + + @property + def Loopback(self): + # type: () -> bool + """ + Returns + ------- + - bool: If enabled, the port is set to internally loopback from transmit to receive. + """ + return self._get_attribute(self._SDM_ATT_MAP["Loopback"]) + + @Loopback.setter + def Loopback(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Loopback"], value) + + @property + def LoopbackMode(self): + # type: () -> str + """ + Returns + ------- + - str(none | internalLoopback): + """ + return self._get_attribute(self._SDM_ATT_MAP["LoopbackMode"]) + + @LoopbackMode.setter + def LoopbackMode(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["LoopbackMode"], value) + + @property + def Ppm(self): + # type: () -> int + """ + Returns + ------- + - number: Indicates the value that needs to be adjusted for the line transmit frequency. + """ + return self._get_attribute(self._SDM_ATT_MAP["Ppm"]) + + @Ppm.setter + def Ppm(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["Ppm"], value) + + @property + def SelectedSpeeds(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str[speed100g | speed200g | speed400g | speed800g]): Which speeds are selected for the current media and AN settings. + """ + return self._get_attribute(self._SDM_ATT_MAP["SelectedSpeeds"]) + + @SelectedSpeeds.setter + def SelectedSpeeds(self, value): + # type: (List[str]) -> None + self._set_attribute(self._SDM_ATT_MAP["SelectedSpeeds"], value) + + @property + def SendSetsMode(self): + # type: () -> str + """ + Returns + ------- + - str(alternate | typeAOnly | typeBOnly): + """ + return self._get_attribute(self._SDM_ATT_MAP["SendSetsMode"]) + + @SendSetsMode.setter + def SendSetsMode(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["SendSetsMode"], value) + + @property + def Speed(self): + # type: () -> str + """ + Returns + ------- + - str(speed100g | speed200g | speed400g | speed800g): + """ + return self._get_attribute(self._SDM_ATT_MAP["Speed"]) + + @Speed.setter + def Speed(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Speed"], value) + + @property + def StartErrorInsertion(self): + # type: () -> bool + """ + Returns + ------- + - bool: + """ + return self._get_attribute(self._SDM_ATT_MAP["StartErrorInsertion"]) + + @StartErrorInsertion.setter + def StartErrorInsertion(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["StartErrorInsertion"], value) + + @property + def TxIgnoreRxLinkFaults(self): + # type: () -> bool + """ + Returns + ------- + - bool: If enabled, will allow transmission of packets even if the receive link is down. + """ + return self._get_attribute(self._SDM_ATT_MAP["TxIgnoreRxLinkFaults"]) + + @TxIgnoreRxLinkFaults.setter + def TxIgnoreRxLinkFaults(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["TxIgnoreRxLinkFaults"], value) + + @property + def TypeAOrderedSets(self): + # type: () -> str + """ + Returns + ------- + - str(localFault | remoteFault): + """ + return self._get_attribute(self._SDM_ATT_MAP["TypeAOrderedSets"]) + + @TypeAOrderedSets.setter + def TypeAOrderedSets(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["TypeAOrderedSets"], value) + + @property + def TypeBOrderedSets(self): + # type: () -> str + """ + Returns + ------- + - str(localFault | remoteFault): + """ + return self._get_attribute(self._SDM_ATT_MAP["TypeBOrderedSets"]) + + @TypeBOrderedSets.setter + def TypeBOrderedSets(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["TypeBOrderedSets"], value) + + def update( + self, + AutoInstrumentation=None, + BadBlocksNumber=None, + EnableAutoNegotiation=None, + EnablePPM=None, + EnabledFlowControl=None, + FlowControlDirectedAddress=None, + GoodBlocksNumber=None, + LaserOn=None, + LinkTraining=None, + LoopContinuously=None, + LoopCountNumber=None, + Loopback=None, + LoopbackMode=None, + Ppm=None, + SelectedSpeeds=None, + SendSetsMode=None, + Speed=None, + StartErrorInsertion=None, + TxIgnoreRxLinkFaults=None, + TypeAOrderedSets=None, + TypeBOrderedSets=None, + ): + # type: (str, int, bool, bool, bool, str, int, bool, bool, bool, int, bool, str, int, List[str], str, str, bool, bool, str, str) -> AresOneEightHundredGigLanQddC + """Updates aresOneEightHundredGigLanQddC resource on the server. + + Args + ---- + - AutoInstrumentation (str(endOfFrame | floating)): The auto instrumentation mode. + - BadBlocksNumber (number): + - EnableAutoNegotiation (bool): + - EnablePPM (bool): If true, enables the portsppm. + - EnabledFlowControl (bool): If true, enables the port's MAC flow control mechanisms to listen for a directed address pause message. + - FlowControlDirectedAddress (str): The 48-bit MAC address that the port listens on for a directed pause. + - GoodBlocksNumber (number): + - LaserOn (bool): + - LinkTraining (bool): + - LoopContinuously (bool): + - LoopCountNumber (number): + - Loopback (bool): If enabled, the port is set to internally loopback from transmit to receive. + - LoopbackMode (str(none | internalLoopback)): + - Ppm (number): Indicates the value that needs to be adjusted for the line transmit frequency. + - SelectedSpeeds (list(str[speed100g | speed200g | speed400g | speed800g])): Which speeds are selected for the current media and AN settings. + - SendSetsMode (str(alternate | typeAOnly | typeBOnly)): + - Speed (str(speed100g | speed200g | speed400g | speed800g)): + - StartErrorInsertion (bool): + - TxIgnoreRxLinkFaults (bool): If enabled, will allow transmission of packets even if the receive link is down. + - TypeAOrderedSets (str(localFault | remoteFault)): + - TypeBOrderedSets (str(localFault | remoteFault)): + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find( + self, + AutoInstrumentation=None, + AvailableSpeeds=None, + BadBlocksNumber=None, + CanModifySpeed=None, + CanSetMultipleSpeeds=None, + EnableAutoNegotiation=None, + EnablePPM=None, + EnabledFlowControl=None, + FlowControlDirectedAddress=None, + GoodBlocksNumber=None, + LaserOn=None, + LinkTraining=None, + LoopContinuously=None, + LoopCountNumber=None, + Loopback=None, + LoopbackMode=None, + Ppm=None, + SelectedSpeeds=None, + SendSetsMode=None, + Speed=None, + StartErrorInsertion=None, + TxIgnoreRxLinkFaults=None, + TypeAOrderedSets=None, + TypeBOrderedSets=None, + ): + # type: (str, List[str], int, bool, bool, bool, bool, bool, str, int, bool, bool, bool, int, bool, str, int, List[str], str, str, bool, bool, str, str) -> AresOneEightHundredGigLanQddC + """Finds and retrieves aresOneEightHundredGigLanQddC resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve aresOneEightHundredGigLanQddC resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all aresOneEightHundredGigLanQddC resources from the server. + + Args + ---- + - AutoInstrumentation (str(endOfFrame | floating)): The auto instrumentation mode. + - AvailableSpeeds (list(str[speed100g | speed200g | speed400g | speed800g])): Which speeds are available for the current media and AN settings. + - BadBlocksNumber (number): + - CanModifySpeed (bool): Returns true/false depending upon if the port can change speed for the current media and AN settings. + - CanSetMultipleSpeeds (bool): Can this port selectmultiple speeds for the current media and AN settings. + - EnableAutoNegotiation (bool): + - EnablePPM (bool): If true, enables the portsppm. + - EnabledFlowControl (bool): If true, enables the port's MAC flow control mechanisms to listen for a directed address pause message. + - FlowControlDirectedAddress (str): The 48-bit MAC address that the port listens on for a directed pause. + - GoodBlocksNumber (number): + - LaserOn (bool): + - LinkTraining (bool): + - LoopContinuously (bool): + - LoopCountNumber (number): + - Loopback (bool): If enabled, the port is set to internally loopback from transmit to receive. + - LoopbackMode (str(none | internalLoopback)): + - Ppm (number): Indicates the value that needs to be adjusted for the line transmit frequency. + - SelectedSpeeds (list(str[speed100g | speed200g | speed400g | speed800g])): Which speeds are selected for the current media and AN settings. + - SendSetsMode (str(alternate | typeAOnly | typeBOnly)): + - Speed (str(speed100g | speed200g | speed400g | speed800g)): + - StartErrorInsertion (bool): + - TxIgnoreRxLinkFaults (bool): If enabled, will allow transmission of packets even if the receive link is down. + - TypeAOrderedSets (str(localFault | remoteFault)): + - TypeBOrderedSets (str(localFault | remoteFault)): + + Returns + ------- + - self: This instance with matching aresOneEightHundredGigLanQddC resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of aresOneEightHundredGigLanQddC data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the aresOneEightHundredGigLanQddC resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/aresoneeighthundredgiglanqddc/fcoe/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/aresoneeighthundredgiglanqddc/fcoe/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/aresoneeighthundredgiglanqddc/fcoe/fcoe.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/aresoneeighthundredgiglanqddc/fcoe/fcoe.py new file mode 100644 index 000000000..297c75b71 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/aresoneeighthundredgiglanqddc/fcoe/fcoe.py @@ -0,0 +1,270 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class Fcoe(Base): + """ + The Fcoe class encapsulates a required fcoe resource which will be retrieved from the server every time the property is accessed. + """ + + __slots__ = () + _SDM_NAME = "fcoe" + _SDM_ATT_MAP = { + "EnablePFCPauseDelay": "enablePFCPauseDelay", + "FlowControlType": "flowControlType", + "PfcPauseDelay": "pfcPauseDelay", + "PfcPriorityGroups": "pfcPriorityGroups", + "PfcQueueGroupSize": "pfcQueueGroupSize", + "PfcQueueGroups": "pfcQueueGroups", + "PriorityGroupSize": "priorityGroupSize", + "SupportDataCenterMode": "supportDataCenterMode", + } + _SDM_ENUM_MAP = { + "flowControlType": ["ieee802.1Qbb", "ieee802.3x"], + "pfcQueueGroupSize": [ + "pfcQueueGroupSize-1", + "pfcQueueGroupSize-4", + "pfcQueueGroupSize-8", + ], + "priorityGroupSize": [ + "priorityGroupSize-1", + "priorityGroupSize-4", + "priorityGroupSize-8", + ], + } + + def __init__(self, parent, list_op=False): + super(Fcoe, self).__init__(parent, list_op) + + @property + def EnablePFCPauseDelay(self): + # type: () -> bool + """ + Returns + ------- + - bool: If true, PFC pause delay is enabled. + """ + return self._get_attribute(self._SDM_ATT_MAP["EnablePFCPauseDelay"]) + + @EnablePFCPauseDelay.setter + def EnablePFCPauseDelay(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["EnablePFCPauseDelay"], value) + + @property + def FlowControlType(self): + # type: () -> str + """ + Returns + ------- + - str(ieee802.1Qbb | ieee802.3x): The type of flow control to be selected. + """ + return self._get_attribute(self._SDM_ATT_MAP["FlowControlType"]) + + @FlowControlType.setter + def FlowControlType(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["FlowControlType"], value) + + @property + def PfcPauseDelay(self): + # type: () -> int + """ + Returns + ------- + - number: If selected, enables to increase the number of frames that is sent when a pause frame is received. + """ + return self._get_attribute(self._SDM_ATT_MAP["PfcPauseDelay"]) + + @PfcPauseDelay.setter + def PfcPauseDelay(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["PfcPauseDelay"], value) + + @property + def PfcPriorityGroups(self): + # type: () -> List[str] + """DEPRECATED + Returns + ------- + - list(str): When you select 802.1Qbb as the flowControlType, you can use the PFC/Priority settings to map each of the eight PFC priorities to one of the two/four/eight Priority Groups (or to None). The PFCs are numbered 0-7. + """ + return self._get_attribute(self._SDM_ATT_MAP["PfcPriorityGroups"]) + + @PfcPriorityGroups.setter + def PfcPriorityGroups(self, value): + # type: (List[str]) -> None + self._set_attribute(self._SDM_ATT_MAP["PfcPriorityGroups"], value) + + @property + def PfcQueueGroupSize(self): + # type: () -> str + """ + Returns + ------- + - str(pfcQueueGroupSize-1 | pfcQueueGroupSize-4 | pfcQueueGroupSize-8): Max PFC queue group size + """ + return self._get_attribute(self._SDM_ATT_MAP["PfcQueueGroupSize"]) + + @PfcQueueGroupSize.setter + def PfcQueueGroupSize(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["PfcQueueGroupSize"], value) + + @property + def PfcQueueGroups(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): When you select 802.1Qbb as the flowControlType, you can use the Priority/PFC Queue settings to map each of the eight PFC priorities to one of the two/four/eight PFC Queue Groups (or to None). + """ + return self._get_attribute(self._SDM_ATT_MAP["PfcQueueGroups"]) + + @PfcQueueGroups.setter + def PfcQueueGroups(self, value): + # type: (List[str]) -> None + self._set_attribute(self._SDM_ATT_MAP["PfcQueueGroups"], value) + + @property + def PriorityGroupSize(self): + # type: () -> str + """DEPRECATED + Returns + ------- + - str(priorityGroupSize-1 | priorityGroupSize-4 | priorityGroupSize-8): The maximum size of a Priority Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["PriorityGroupSize"]) + + @PriorityGroupSize.setter + def PriorityGroupSize(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["PriorityGroupSize"], value) + + @property + def SupportDataCenterMode(self): + # type: () -> bool + """ + Returns + ------- + - bool: If true, this mode automatically sets Transmit Mode to Interleaved Streams. + """ + return self._get_attribute(self._SDM_ATT_MAP["SupportDataCenterMode"]) + + @SupportDataCenterMode.setter + def SupportDataCenterMode(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["SupportDataCenterMode"], value) + + def update( + self, + EnablePFCPauseDelay=None, + FlowControlType=None, + PfcPauseDelay=None, + PfcPriorityGroups=None, + PfcQueueGroupSize=None, + PfcQueueGroups=None, + PriorityGroupSize=None, + SupportDataCenterMode=None, + ): + # type: (bool, str, int, List[str], str, List[str], str, bool) -> Fcoe + """Updates fcoe resource on the server. + + Args + ---- + - EnablePFCPauseDelay (bool): If true, PFC pause delay is enabled. + - FlowControlType (str(ieee802.1Qbb | ieee802.3x)): The type of flow control to be selected. + - PfcPauseDelay (number): If selected, enables to increase the number of frames that is sent when a pause frame is received. + - PfcPriorityGroups (list(str)): When you select 802.1Qbb as the flowControlType, you can use the PFC/Priority settings to map each of the eight PFC priorities to one of the two/four/eight Priority Groups (or to None). The PFCs are numbered 0-7. + - PfcQueueGroupSize (str(pfcQueueGroupSize-1 | pfcQueueGroupSize-4 | pfcQueueGroupSize-8)): Max PFC queue group size + - PfcQueueGroups (list(str)): When you select 802.1Qbb as the flowControlType, you can use the Priority/PFC Queue settings to map each of the eight PFC priorities to one of the two/four/eight PFC Queue Groups (or to None). + - PriorityGroupSize (str(priorityGroupSize-1 | priorityGroupSize-4 | priorityGroupSize-8)): The maximum size of a Priority Group. + - SupportDataCenterMode (bool): If true, this mode automatically sets Transmit Mode to Interleaved Streams. + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find( + self, + EnablePFCPauseDelay=None, + FlowControlType=None, + PfcPauseDelay=None, + PfcPriorityGroups=None, + PfcQueueGroupSize=None, + PfcQueueGroups=None, + PriorityGroupSize=None, + SupportDataCenterMode=None, + ): + # type: (bool, str, int, List[str], str, List[str], str, bool) -> Fcoe + """Finds and retrieves fcoe resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve fcoe resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all fcoe resources from the server. + + Args + ---- + - EnablePFCPauseDelay (bool): If true, PFC pause delay is enabled. + - FlowControlType (str(ieee802.1Qbb | ieee802.3x)): The type of flow control to be selected. + - PfcPauseDelay (number): If selected, enables to increase the number of frames that is sent when a pause frame is received. + - PfcPriorityGroups (list(str)): When you select 802.1Qbb as the flowControlType, you can use the PFC/Priority settings to map each of the eight PFC priorities to one of the two/four/eight Priority Groups (or to None). The PFCs are numbered 0-7. + - PfcQueueGroupSize (str(pfcQueueGroupSize-1 | pfcQueueGroupSize-4 | pfcQueueGroupSize-8)): Max PFC queue group size + - PfcQueueGroups (list(str)): When you select 802.1Qbb as the flowControlType, you can use the Priority/PFC Queue settings to map each of the eight PFC priorities to one of the two/four/eight PFC Queue Groups (or to None). + - PriorityGroupSize (str(priorityGroupSize-1 | priorityGroupSize-4 | priorityGroupSize-8)): The maximum size of a Priority Group. + - SupportDataCenterMode (bool): If true, this mode automatically sets Transmit Mode to Interleaved Streams. + + Returns + ------- + - self: This instance with matching fcoe resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of fcoe data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the fcoe resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/l1config.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/l1config.py index 9e0ec273b..39bb309e2 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/l1config.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/l1config.py @@ -69,6 +69,10 @@ class L1Config(Base): "novus5GTenTwentyFiveGigLanFcoe", "starFourHundredGigLan", "starFourHundredGigLanFcoe", + "ravenEightHundredGigLan", + "ravenEightHundredGigLanFcoe", + "aresOneEightHundredGigLanQddC", + "aresOneEightHundredGigLanQddCFcoe", ], } @@ -95,6 +99,26 @@ def OAM(self): return self._properties.get("OAM") return OAM(self)._select() + @property + def AresOneEightHundredGigLanQddC(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.vport.l1config.aresoneeighthundredgiglanqddc.aresoneeighthundredgiglanqddc.AresOneEightHundredGigLanQddC): An instance of the AresOneEightHundredGigLanQddC class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.vport.l1config.aresoneeighthundredgiglanqddc.aresoneeighthundredgiglanqddc import ( + AresOneEightHundredGigLanQddC, + ) + + if len(self._object_properties) > 0: + if self._properties.get("AresOneEightHundredGigLanQddC", None) is not None: + return self._properties.get("AresOneEightHundredGigLanQddC") + return AresOneEightHundredGigLanQddC(self)._select() + @property def AresOneFourHundredGigLan(self): """ @@ -415,6 +439,26 @@ def Qbv(self): return self._properties.get("Qbv") return Qbv(self)._select() + @property + def RavenEightHundredGigLan(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.vport.l1config.raveneighthundredgiglan.raveneighthundredgiglan.RavenEightHundredGigLan): An instance of the RavenEightHundredGigLan class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.vport.l1config.raveneighthundredgiglan.raveneighthundredgiglan import ( + RavenEightHundredGigLan, + ) + + if len(self._object_properties) > 0: + if self._properties.get("RavenEightHundredGigLan", None) is not None: + return self._properties.get("RavenEightHundredGigLan") + return RavenEightHundredGigLan(self)._select() + @property def RxFilters(self): """ @@ -541,7 +585,7 @@ def CurrentType(self): """ Returns ------- - - str(ethernet | ethernetvm | ethernetFcoe | atm | pos | tenGigLan | tenGigLanFcoe | fortyGigLan | fortyGigLanFcoe | tenGigWan | tenGigWanFcoe | hundredGigLan | hundredGigLanFcoe | tenFortyHundredGigLan | tenFortyHundredGigLanFcoe | fc | ethernetImpairment | novusHundredGigLan | novusHundredGigLanFcoe | novusTenGigLan | novusTenGigLanFcoe | krakenFourHundredGigLan | krakenFourHundredGigLanFcoe | aresOneFourHundredGigLan | aresOneFourHundredGigLanFcoe | uhdOneHundredGigLan | novus5GTenTwentyFiveGigLan | novus5GTenTwentyFiveGigLanFcoe | starFourHundredGigLan | starFourHundredGigLanFcoe): Indicates the types of ports for configuration to choose from. + - str(ethernet | ethernetvm | ethernetFcoe | atm | pos | tenGigLan | tenGigLanFcoe | fortyGigLan | fortyGigLanFcoe | tenGigWan | tenGigWanFcoe | hundredGigLan | hundredGigLanFcoe | tenFortyHundredGigLan | tenFortyHundredGigLanFcoe | fc | ethernetImpairment | novusHundredGigLan | novusHundredGigLanFcoe | novusTenGigLan | novusTenGigLanFcoe | krakenFourHundredGigLan | krakenFourHundredGigLanFcoe | aresOneFourHundredGigLan | aresOneFourHundredGigLanFcoe | uhdOneHundredGigLan | novus5GTenTwentyFiveGigLan | novus5GTenTwentyFiveGigLanFcoe | starFourHundredGigLan | starFourHundredGigLanFcoe | ravenEightHundredGigLan | ravenEightHundredGigLanFcoe | aresOneEightHundredGigLanQddC | aresOneEightHundredGigLanQddCFcoe): Indicates the types of ports for configuration to choose from. """ return self._get_attribute(self._SDM_ATT_MAP["CurrentType"]) @@ -556,7 +600,7 @@ def update(self, CurrentType=None): Args ---- - - CurrentType (str(ethernet | ethernetvm | ethernetFcoe | atm | pos | tenGigLan | tenGigLanFcoe | fortyGigLan | fortyGigLanFcoe | tenGigWan | tenGigWanFcoe | hundredGigLan | hundredGigLanFcoe | tenFortyHundredGigLan | tenFortyHundredGigLanFcoe | fc | ethernetImpairment | novusHundredGigLan | novusHundredGigLanFcoe | novusTenGigLan | novusTenGigLanFcoe | krakenFourHundredGigLan | krakenFourHundredGigLanFcoe | aresOneFourHundredGigLan | aresOneFourHundredGigLanFcoe | uhdOneHundredGigLan | novus5GTenTwentyFiveGigLan | novus5GTenTwentyFiveGigLanFcoe | starFourHundredGigLan | starFourHundredGigLanFcoe)): Indicates the types of ports for configuration to choose from. + - CurrentType (str(ethernet | ethernetvm | ethernetFcoe | atm | pos | tenGigLan | tenGigLanFcoe | fortyGigLan | fortyGigLanFcoe | tenGigWan | tenGigWanFcoe | hundredGigLan | hundredGigLanFcoe | tenFortyHundredGigLan | tenFortyHundredGigLanFcoe | fc | ethernetImpairment | novusHundredGigLan | novusHundredGigLanFcoe | novusTenGigLan | novusTenGigLanFcoe | krakenFourHundredGigLan | krakenFourHundredGigLanFcoe | aresOneFourHundredGigLan | aresOneFourHundredGigLanFcoe | uhdOneHundredGigLan | novus5GTenTwentyFiveGigLan | novus5GTenTwentyFiveGigLanFcoe | starFourHundredGigLan | starFourHundredGigLanFcoe | ravenEightHundredGigLan | ravenEightHundredGigLanFcoe | aresOneEightHundredGigLanQddC | aresOneEightHundredGigLanQddCFcoe)): Indicates the types of ports for configuration to choose from. Raises ------ @@ -574,7 +618,7 @@ def find(self, CurrentType=None): Args ---- - - CurrentType (str(ethernet | ethernetvm | ethernetFcoe | atm | pos | tenGigLan | tenGigLanFcoe | fortyGigLan | fortyGigLanFcoe | tenGigWan | tenGigWanFcoe | hundredGigLan | hundredGigLanFcoe | tenFortyHundredGigLan | tenFortyHundredGigLanFcoe | fc | ethernetImpairment | novusHundredGigLan | novusHundredGigLanFcoe | novusTenGigLan | novusTenGigLanFcoe | krakenFourHundredGigLan | krakenFourHundredGigLanFcoe | aresOneFourHundredGigLan | aresOneFourHundredGigLanFcoe | uhdOneHundredGigLan | novus5GTenTwentyFiveGigLan | novus5GTenTwentyFiveGigLanFcoe | starFourHundredGigLan | starFourHundredGigLanFcoe)): Indicates the types of ports for configuration to choose from. + - CurrentType (str(ethernet | ethernetvm | ethernetFcoe | atm | pos | tenGigLan | tenGigLanFcoe | fortyGigLan | fortyGigLanFcoe | tenGigWan | tenGigWanFcoe | hundredGigLan | hundredGigLanFcoe | tenFortyHundredGigLan | tenFortyHundredGigLanFcoe | fc | ethernetImpairment | novusHundredGigLan | novusHundredGigLanFcoe | novusTenGigLan | novusTenGigLanFcoe | krakenFourHundredGigLan | krakenFourHundredGigLanFcoe | aresOneFourHundredGigLan | aresOneFourHundredGigLanFcoe | uhdOneHundredGigLan | novus5GTenTwentyFiveGigLan | novus5GTenTwentyFiveGigLanFcoe | starFourHundredGigLan | starFourHundredGigLanFcoe | ravenEightHundredGigLan | ravenEightHundredGigLanFcoe | aresOneEightHundredGigLanQddC | aresOneEightHundredGigLanQddCFcoe)): Indicates the types of ports for configuration to choose from. Returns ------- diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/raveneighthundredgiglan/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/raveneighthundredgiglan/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/raveneighthundredgiglan/fcoe/__init__.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/raveneighthundredgiglan/fcoe/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/raveneighthundredgiglan/fcoe/fcoe.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/raveneighthundredgiglan/fcoe/fcoe.py new file mode 100644 index 000000000..297c75b71 --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/raveneighthundredgiglan/fcoe/fcoe.py @@ -0,0 +1,270 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class Fcoe(Base): + """ + The Fcoe class encapsulates a required fcoe resource which will be retrieved from the server every time the property is accessed. + """ + + __slots__ = () + _SDM_NAME = "fcoe" + _SDM_ATT_MAP = { + "EnablePFCPauseDelay": "enablePFCPauseDelay", + "FlowControlType": "flowControlType", + "PfcPauseDelay": "pfcPauseDelay", + "PfcPriorityGroups": "pfcPriorityGroups", + "PfcQueueGroupSize": "pfcQueueGroupSize", + "PfcQueueGroups": "pfcQueueGroups", + "PriorityGroupSize": "priorityGroupSize", + "SupportDataCenterMode": "supportDataCenterMode", + } + _SDM_ENUM_MAP = { + "flowControlType": ["ieee802.1Qbb", "ieee802.3x"], + "pfcQueueGroupSize": [ + "pfcQueueGroupSize-1", + "pfcQueueGroupSize-4", + "pfcQueueGroupSize-8", + ], + "priorityGroupSize": [ + "priorityGroupSize-1", + "priorityGroupSize-4", + "priorityGroupSize-8", + ], + } + + def __init__(self, parent, list_op=False): + super(Fcoe, self).__init__(parent, list_op) + + @property + def EnablePFCPauseDelay(self): + # type: () -> bool + """ + Returns + ------- + - bool: If true, PFC pause delay is enabled. + """ + return self._get_attribute(self._SDM_ATT_MAP["EnablePFCPauseDelay"]) + + @EnablePFCPauseDelay.setter + def EnablePFCPauseDelay(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["EnablePFCPauseDelay"], value) + + @property + def FlowControlType(self): + # type: () -> str + """ + Returns + ------- + - str(ieee802.1Qbb | ieee802.3x): The type of flow control to be selected. + """ + return self._get_attribute(self._SDM_ATT_MAP["FlowControlType"]) + + @FlowControlType.setter + def FlowControlType(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["FlowControlType"], value) + + @property + def PfcPauseDelay(self): + # type: () -> int + """ + Returns + ------- + - number: If selected, enables to increase the number of frames that is sent when a pause frame is received. + """ + return self._get_attribute(self._SDM_ATT_MAP["PfcPauseDelay"]) + + @PfcPauseDelay.setter + def PfcPauseDelay(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["PfcPauseDelay"], value) + + @property + def PfcPriorityGroups(self): + # type: () -> List[str] + """DEPRECATED + Returns + ------- + - list(str): When you select 802.1Qbb as the flowControlType, you can use the PFC/Priority settings to map each of the eight PFC priorities to one of the two/four/eight Priority Groups (or to None). The PFCs are numbered 0-7. + """ + return self._get_attribute(self._SDM_ATT_MAP["PfcPriorityGroups"]) + + @PfcPriorityGroups.setter + def PfcPriorityGroups(self, value): + # type: (List[str]) -> None + self._set_attribute(self._SDM_ATT_MAP["PfcPriorityGroups"], value) + + @property + def PfcQueueGroupSize(self): + # type: () -> str + """ + Returns + ------- + - str(pfcQueueGroupSize-1 | pfcQueueGroupSize-4 | pfcQueueGroupSize-8): Max PFC queue group size + """ + return self._get_attribute(self._SDM_ATT_MAP["PfcQueueGroupSize"]) + + @PfcQueueGroupSize.setter + def PfcQueueGroupSize(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["PfcQueueGroupSize"], value) + + @property + def PfcQueueGroups(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str): When you select 802.1Qbb as the flowControlType, you can use the Priority/PFC Queue settings to map each of the eight PFC priorities to one of the two/four/eight PFC Queue Groups (or to None). + """ + return self._get_attribute(self._SDM_ATT_MAP["PfcQueueGroups"]) + + @PfcQueueGroups.setter + def PfcQueueGroups(self, value): + # type: (List[str]) -> None + self._set_attribute(self._SDM_ATT_MAP["PfcQueueGroups"], value) + + @property + def PriorityGroupSize(self): + # type: () -> str + """DEPRECATED + Returns + ------- + - str(priorityGroupSize-1 | priorityGroupSize-4 | priorityGroupSize-8): The maximum size of a Priority Group. + """ + return self._get_attribute(self._SDM_ATT_MAP["PriorityGroupSize"]) + + @PriorityGroupSize.setter + def PriorityGroupSize(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["PriorityGroupSize"], value) + + @property + def SupportDataCenterMode(self): + # type: () -> bool + """ + Returns + ------- + - bool: If true, this mode automatically sets Transmit Mode to Interleaved Streams. + """ + return self._get_attribute(self._SDM_ATT_MAP["SupportDataCenterMode"]) + + @SupportDataCenterMode.setter + def SupportDataCenterMode(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["SupportDataCenterMode"], value) + + def update( + self, + EnablePFCPauseDelay=None, + FlowControlType=None, + PfcPauseDelay=None, + PfcPriorityGroups=None, + PfcQueueGroupSize=None, + PfcQueueGroups=None, + PriorityGroupSize=None, + SupportDataCenterMode=None, + ): + # type: (bool, str, int, List[str], str, List[str], str, bool) -> Fcoe + """Updates fcoe resource on the server. + + Args + ---- + - EnablePFCPauseDelay (bool): If true, PFC pause delay is enabled. + - FlowControlType (str(ieee802.1Qbb | ieee802.3x)): The type of flow control to be selected. + - PfcPauseDelay (number): If selected, enables to increase the number of frames that is sent when a pause frame is received. + - PfcPriorityGroups (list(str)): When you select 802.1Qbb as the flowControlType, you can use the PFC/Priority settings to map each of the eight PFC priorities to one of the two/four/eight Priority Groups (or to None). The PFCs are numbered 0-7. + - PfcQueueGroupSize (str(pfcQueueGroupSize-1 | pfcQueueGroupSize-4 | pfcQueueGroupSize-8)): Max PFC queue group size + - PfcQueueGroups (list(str)): When you select 802.1Qbb as the flowControlType, you can use the Priority/PFC Queue settings to map each of the eight PFC priorities to one of the two/four/eight PFC Queue Groups (or to None). + - PriorityGroupSize (str(priorityGroupSize-1 | priorityGroupSize-4 | priorityGroupSize-8)): The maximum size of a Priority Group. + - SupportDataCenterMode (bool): If true, this mode automatically sets Transmit Mode to Interleaved Streams. + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find( + self, + EnablePFCPauseDelay=None, + FlowControlType=None, + PfcPauseDelay=None, + PfcPriorityGroups=None, + PfcQueueGroupSize=None, + PfcQueueGroups=None, + PriorityGroupSize=None, + SupportDataCenterMode=None, + ): + # type: (bool, str, int, List[str], str, List[str], str, bool) -> Fcoe + """Finds and retrieves fcoe resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve fcoe resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all fcoe resources from the server. + + Args + ---- + - EnablePFCPauseDelay (bool): If true, PFC pause delay is enabled. + - FlowControlType (str(ieee802.1Qbb | ieee802.3x)): The type of flow control to be selected. + - PfcPauseDelay (number): If selected, enables to increase the number of frames that is sent when a pause frame is received. + - PfcPriorityGroups (list(str)): When you select 802.1Qbb as the flowControlType, you can use the PFC/Priority settings to map each of the eight PFC priorities to one of the two/four/eight Priority Groups (or to None). The PFCs are numbered 0-7. + - PfcQueueGroupSize (str(pfcQueueGroupSize-1 | pfcQueueGroupSize-4 | pfcQueueGroupSize-8)): Max PFC queue group size + - PfcQueueGroups (list(str)): When you select 802.1Qbb as the flowControlType, you can use the Priority/PFC Queue settings to map each of the eight PFC priorities to one of the two/four/eight PFC Queue Groups (or to None). + - PriorityGroupSize (str(priorityGroupSize-1 | priorityGroupSize-4 | priorityGroupSize-8)): The maximum size of a Priority Group. + - SupportDataCenterMode (bool): If true, this mode automatically sets Transmit Mode to Interleaved Streams. + + Returns + ------- + - self: This instance with matching fcoe resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of fcoe data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the fcoe resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/raveneighthundredgiglan/raveneighthundredgiglan.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/raveneighthundredgiglan/raveneighthundredgiglan.py new file mode 100644 index 000000000..91a35203c --- /dev/null +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/l1config/raveneighthundredgiglan/raveneighthundredgiglan.py @@ -0,0 +1,544 @@ +# MIT LICENSE +# +# Copyright 1997 - 2020 by IXIA Keysight +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), +# to deal in the Software without restriction, including without limitation +# the rights to use, copy, modify, merge, publish, distribute, sublicense, +# and/or sell copies of the Software, and to permit persons to whom the +# Software is furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +import sys +from ixnetwork_restpy.base import Base +from ixnetwork_restpy.files import Files + +if sys.version_info >= (3, 5): + from typing import List, Any, Union + + +class RavenEightHundredGigLan(Base): + """ + The RavenEightHundredGigLan class encapsulates a required ravenEightHundredGigLan resource which will be retrieved from the server every time the property is accessed. + """ + + __slots__ = () + _SDM_NAME = "ravenEightHundredGigLan" + _SDM_ATT_MAP = { + "AutoInstrumentation": "autoInstrumentation", + "AvailableSpeeds": "availableSpeeds", + "BadBlocksNumber": "badBlocksNumber", + "CanModifySpeed": "canModifySpeed", + "CanSetMultipleSpeeds": "canSetMultipleSpeeds", + "EnablePPM": "enablePPM", + "EnabledFlowControl": "enabledFlowControl", + "FlowControlDirectedAddress": "flowControlDirectedAddress", + "GoodBlocksNumber": "goodBlocksNumber", + "LaserOn": "laserOn", + "LoopContinuously": "loopContinuously", + "LoopCountNumber": "loopCountNumber", + "Loopback": "loopback", + "LoopbackMode": "loopbackMode", + "Ppm": "ppm", + "SelectedSpeeds": "selectedSpeeds", + "SendSetsMode": "sendSetsMode", + "Speed": "speed", + "StartErrorInsertion": "startErrorInsertion", + "TxIgnoreRxLinkFaults": "txIgnoreRxLinkFaults", + "TypeAOrderedSets": "typeAOrderedSets", + "TypeBOrderedSets": "typeBOrderedSets", + } + _SDM_ENUM_MAP = { + "autoInstrumentation": ["endOfFrame", "floating"], + "loopbackMode": ["none", "internalLoopback"], + "sendSetsMode": ["alternate", "typeAOnly", "typeBOnly"], + "speed": ["speed100g", "speed200g", "speed400g", "speed800g"], + "typeAOrderedSets": ["localFault", "remoteFault"], + "typeBOrderedSets": ["localFault", "remoteFault"], + } + + def __init__(self, parent, list_op=False): + super(RavenEightHundredGigLan, self).__init__(parent, list_op) + + @property + def Fcoe(self): + """ + Returns + ------- + - obj(ixnetwork_restpy.testplatform.sessions.ixnetwork.vport.l1config.raveneighthundredgiglan.fcoe.fcoe.Fcoe): An instance of the Fcoe class + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + from ixnetwork_restpy.testplatform.sessions.ixnetwork.vport.l1config.raveneighthundredgiglan.fcoe.fcoe import ( + Fcoe, + ) + + if len(self._object_properties) > 0: + if self._properties.get("Fcoe", None) is not None: + return self._properties.get("Fcoe") + return Fcoe(self)._select() + + @property + def AutoInstrumentation(self): + # type: () -> str + """ + Returns + ------- + - str(endOfFrame | floating): The auto instrumentation mode. + """ + return self._get_attribute(self._SDM_ATT_MAP["AutoInstrumentation"]) + + @AutoInstrumentation.setter + def AutoInstrumentation(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["AutoInstrumentation"], value) + + @property + def AvailableSpeeds(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str[speed100g | speed200g | speed400g | speed800g]): Which speeds are available for the current media and AN settings. + """ + return self._get_attribute(self._SDM_ATT_MAP["AvailableSpeeds"]) + + @property + def BadBlocksNumber(self): + # type: () -> int + """ + Returns + ------- + - number: + """ + return self._get_attribute(self._SDM_ATT_MAP["BadBlocksNumber"]) + + @BadBlocksNumber.setter + def BadBlocksNumber(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["BadBlocksNumber"], value) + + @property + def CanModifySpeed(self): + # type: () -> bool + """ + Returns + ------- + - bool: Returns true/false depending upon if the port can change speed for the current media and AN settings. + """ + return self._get_attribute(self._SDM_ATT_MAP["CanModifySpeed"]) + + @property + def CanSetMultipleSpeeds(self): + # type: () -> bool + """ + Returns + ------- + - bool: Can this port selectmultiple speeds for the current media and AN settings. + """ + return self._get_attribute(self._SDM_ATT_MAP["CanSetMultipleSpeeds"]) + + @property + def EnablePPM(self): + # type: () -> bool + """ + Returns + ------- + - bool: If true, enables the portsppm. + """ + return self._get_attribute(self._SDM_ATT_MAP["EnablePPM"]) + + @EnablePPM.setter + def EnablePPM(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["EnablePPM"], value) + + @property + def EnabledFlowControl(self): + # type: () -> bool + """ + Returns + ------- + - bool: If true, enables the port's MAC flow control mechanisms to listen for a directed address pause message. + """ + return self._get_attribute(self._SDM_ATT_MAP["EnabledFlowControl"]) + + @EnabledFlowControl.setter + def EnabledFlowControl(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["EnabledFlowControl"], value) + + @property + def FlowControlDirectedAddress(self): + # type: () -> str + """ + Returns + ------- + - str: The 48-bit MAC address that the port listens on for a directed pause. + """ + return self._get_attribute(self._SDM_ATT_MAP["FlowControlDirectedAddress"]) + + @FlowControlDirectedAddress.setter + def FlowControlDirectedAddress(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["FlowControlDirectedAddress"], value) + + @property + def GoodBlocksNumber(self): + # type: () -> int + """ + Returns + ------- + - number: + """ + return self._get_attribute(self._SDM_ATT_MAP["GoodBlocksNumber"]) + + @GoodBlocksNumber.setter + def GoodBlocksNumber(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["GoodBlocksNumber"], value) + + @property + def LaserOn(self): + # type: () -> bool + """ + Returns + ------- + - bool: + """ + return self._get_attribute(self._SDM_ATT_MAP["LaserOn"]) + + @LaserOn.setter + def LaserOn(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["LaserOn"], value) + + @property + def LoopContinuously(self): + # type: () -> bool + """ + Returns + ------- + - bool: + """ + return self._get_attribute(self._SDM_ATT_MAP["LoopContinuously"]) + + @LoopContinuously.setter + def LoopContinuously(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["LoopContinuously"], value) + + @property + def LoopCountNumber(self): + # type: () -> int + """ + Returns + ------- + - number: + """ + return self._get_attribute(self._SDM_ATT_MAP["LoopCountNumber"]) + + @LoopCountNumber.setter + def LoopCountNumber(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["LoopCountNumber"], value) + + @property + def Loopback(self): + # type: () -> bool + """ + Returns + ------- + - bool: If enabled, the port is set to internally loopback from transmit to receive. + """ + return self._get_attribute(self._SDM_ATT_MAP["Loopback"]) + + @Loopback.setter + def Loopback(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["Loopback"], value) + + @property + def LoopbackMode(self): + # type: () -> str + """ + Returns + ------- + - str(none | internalLoopback): + """ + return self._get_attribute(self._SDM_ATT_MAP["LoopbackMode"]) + + @LoopbackMode.setter + def LoopbackMode(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["LoopbackMode"], value) + + @property + def Ppm(self): + # type: () -> int + """ + Returns + ------- + - number: Indicates the value that needs to be adjusted for the line transmit frequency. + """ + return self._get_attribute(self._SDM_ATT_MAP["Ppm"]) + + @Ppm.setter + def Ppm(self, value): + # type: (int) -> None + self._set_attribute(self._SDM_ATT_MAP["Ppm"], value) + + @property + def SelectedSpeeds(self): + # type: () -> List[str] + """ + Returns + ------- + - list(str[speed100g | speed200g | speed400g | speed800g]): Which speeds are selected for the current media and AN settings. + """ + return self._get_attribute(self._SDM_ATT_MAP["SelectedSpeeds"]) + + @SelectedSpeeds.setter + def SelectedSpeeds(self, value): + # type: (List[str]) -> None + self._set_attribute(self._SDM_ATT_MAP["SelectedSpeeds"], value) + + @property + def SendSetsMode(self): + # type: () -> str + """ + Returns + ------- + - str(alternate | typeAOnly | typeBOnly): + """ + return self._get_attribute(self._SDM_ATT_MAP["SendSetsMode"]) + + @SendSetsMode.setter + def SendSetsMode(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["SendSetsMode"], value) + + @property + def Speed(self): + # type: () -> str + """ + Returns + ------- + - str(speed100g | speed200g | speed400g | speed800g): + """ + return self._get_attribute(self._SDM_ATT_MAP["Speed"]) + + @Speed.setter + def Speed(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["Speed"], value) + + @property + def StartErrorInsertion(self): + # type: () -> bool + """ + Returns + ------- + - bool: + """ + return self._get_attribute(self._SDM_ATT_MAP["StartErrorInsertion"]) + + @StartErrorInsertion.setter + def StartErrorInsertion(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["StartErrorInsertion"], value) + + @property + def TxIgnoreRxLinkFaults(self): + # type: () -> bool + """ + Returns + ------- + - bool: If enabled, will allow transmission of packets even if the receive link is down. + """ + return self._get_attribute(self._SDM_ATT_MAP["TxIgnoreRxLinkFaults"]) + + @TxIgnoreRxLinkFaults.setter + def TxIgnoreRxLinkFaults(self, value): + # type: (bool) -> None + self._set_attribute(self._SDM_ATT_MAP["TxIgnoreRxLinkFaults"], value) + + @property + def TypeAOrderedSets(self): + # type: () -> str + """ + Returns + ------- + - str(localFault | remoteFault): + """ + return self._get_attribute(self._SDM_ATT_MAP["TypeAOrderedSets"]) + + @TypeAOrderedSets.setter + def TypeAOrderedSets(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["TypeAOrderedSets"], value) + + @property + def TypeBOrderedSets(self): + # type: () -> str + """ + Returns + ------- + - str(localFault | remoteFault): + """ + return self._get_attribute(self._SDM_ATT_MAP["TypeBOrderedSets"]) + + @TypeBOrderedSets.setter + def TypeBOrderedSets(self, value): + # type: (str) -> None + self._set_attribute(self._SDM_ATT_MAP["TypeBOrderedSets"], value) + + def update( + self, + AutoInstrumentation=None, + BadBlocksNumber=None, + EnablePPM=None, + EnabledFlowControl=None, + FlowControlDirectedAddress=None, + GoodBlocksNumber=None, + LaserOn=None, + LoopContinuously=None, + LoopCountNumber=None, + Loopback=None, + LoopbackMode=None, + Ppm=None, + SelectedSpeeds=None, + SendSetsMode=None, + Speed=None, + StartErrorInsertion=None, + TxIgnoreRxLinkFaults=None, + TypeAOrderedSets=None, + TypeBOrderedSets=None, + ): + # type: (str, int, bool, bool, str, int, bool, bool, int, bool, str, int, List[str], str, str, bool, bool, str, str) -> RavenEightHundredGigLan + """Updates ravenEightHundredGigLan resource on the server. + + Args + ---- + - AutoInstrumentation (str(endOfFrame | floating)): The auto instrumentation mode. + - BadBlocksNumber (number): + - EnablePPM (bool): If true, enables the portsppm. + - EnabledFlowControl (bool): If true, enables the port's MAC flow control mechanisms to listen for a directed address pause message. + - FlowControlDirectedAddress (str): The 48-bit MAC address that the port listens on for a directed pause. + - GoodBlocksNumber (number): + - LaserOn (bool): + - LoopContinuously (bool): + - LoopCountNumber (number): + - Loopback (bool): If enabled, the port is set to internally loopback from transmit to receive. + - LoopbackMode (str(none | internalLoopback)): + - Ppm (number): Indicates the value that needs to be adjusted for the line transmit frequency. + - SelectedSpeeds (list(str[speed100g | speed200g | speed400g | speed800g])): Which speeds are selected for the current media and AN settings. + - SendSetsMode (str(alternate | typeAOnly | typeBOnly)): + - Speed (str(speed100g | speed200g | speed400g | speed800g)): + - StartErrorInsertion (bool): + - TxIgnoreRxLinkFaults (bool): If enabled, will allow transmission of packets even if the receive link is down. + - TypeAOrderedSets (str(localFault | remoteFault)): + - TypeBOrderedSets (str(localFault | remoteFault)): + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._update(self._map_locals(self._SDM_ATT_MAP, locals())) + + def find( + self, + AutoInstrumentation=None, + AvailableSpeeds=None, + BadBlocksNumber=None, + CanModifySpeed=None, + CanSetMultipleSpeeds=None, + EnablePPM=None, + EnabledFlowControl=None, + FlowControlDirectedAddress=None, + GoodBlocksNumber=None, + LaserOn=None, + LoopContinuously=None, + LoopCountNumber=None, + Loopback=None, + LoopbackMode=None, + Ppm=None, + SelectedSpeeds=None, + SendSetsMode=None, + Speed=None, + StartErrorInsertion=None, + TxIgnoreRxLinkFaults=None, + TypeAOrderedSets=None, + TypeBOrderedSets=None, + ): + # type: (str, List[str], int, bool, bool, bool, bool, str, int, bool, bool, int, bool, str, int, List[str], str, str, bool, bool, str, str) -> RavenEightHundredGigLan + """Finds and retrieves ravenEightHundredGigLan resources from the server. + + All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve ravenEightHundredGigLan resources from the server. + To retrieve an exact match ensure the parameter value starts with ^ and ends with $ + By default the find method takes no parameters and will retrieve all ravenEightHundredGigLan resources from the server. + + Args + ---- + - AutoInstrumentation (str(endOfFrame | floating)): The auto instrumentation mode. + - AvailableSpeeds (list(str[speed100g | speed200g | speed400g | speed800g])): Which speeds are available for the current media and AN settings. + - BadBlocksNumber (number): + - CanModifySpeed (bool): Returns true/false depending upon if the port can change speed for the current media and AN settings. + - CanSetMultipleSpeeds (bool): Can this port selectmultiple speeds for the current media and AN settings. + - EnablePPM (bool): If true, enables the portsppm. + - EnabledFlowControl (bool): If true, enables the port's MAC flow control mechanisms to listen for a directed address pause message. + - FlowControlDirectedAddress (str): The 48-bit MAC address that the port listens on for a directed pause. + - GoodBlocksNumber (number): + - LaserOn (bool): + - LoopContinuously (bool): + - LoopCountNumber (number): + - Loopback (bool): If enabled, the port is set to internally loopback from transmit to receive. + - LoopbackMode (str(none | internalLoopback)): + - Ppm (number): Indicates the value that needs to be adjusted for the line transmit frequency. + - SelectedSpeeds (list(str[speed100g | speed200g | speed400g | speed800g])): Which speeds are selected for the current media and AN settings. + - SendSetsMode (str(alternate | typeAOnly | typeBOnly)): + - Speed (str(speed100g | speed200g | speed400g | speed800g)): + - StartErrorInsertion (bool): + - TxIgnoreRxLinkFaults (bool): If enabled, will allow transmission of packets even if the receive link is down. + - TypeAOrderedSets (str(localFault | remoteFault)): + - TypeBOrderedSets (str(localFault | remoteFault)): + + Returns + ------- + - self: This instance with matching ravenEightHundredGigLan resources retrieved from the server available through an iterator or index + + Raises + ------ + - ServerError: The server has encountered an uncategorized error condition + """ + return self._select(self._map_locals(self._SDM_ATT_MAP, locals())) + + def read(self, href): + """Retrieves a single instance of ravenEightHundredGigLan data from the server. + + Args + ---- + - href (str): An href to the instance to be retrieved + + Returns + ------- + - self: This instance with the ravenEightHundredGigLan resources from the server available through an iterator or index + + Raises + ------ + - NotFoundError: The requested resource does not exist on the server + - ServerError: The server has encountered an uncategorized error condition + """ + return self._read(href) diff --git a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/vport.py b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/vport.py index 5d68c1221..93bf69da2 100644 --- a/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/vport.py +++ b/ixnetwork_restpy/testplatform/sessions/ixnetwork/vport/vport.py @@ -62,6 +62,7 @@ class Vport(Base): "Licenses": "licenses", "Location": "location", "MacsecEnabled": "macsecEnabled", + "MaxStreamsSupported": "maxStreamsSupported", "Name": "name", "ResourceMode": "resourceMode", "RxMode": "rxMode", @@ -147,6 +148,10 @@ class Vport(Base): "novus5GTenTwentyFiveGigLanFcoe", "starFourHundredGigLan", "starFourHundredGigLanFcoe", + "ravenEightHundredGigLan", + "ravenEightHundredGigLanFcoe", + "aresOneEightHundredGigLanQddC", + "aresOneEightHundredGigLanQddCFcoe", ], } @@ -600,6 +605,16 @@ def MacsecEnabled(self): """ return self._get_attribute(self._SDM_ATT_MAP["MacsecEnabled"]) + @property + def MaxStreamsSupported(self): + # type: () -> str + """ + Returns + ------- + - str: + """ + return self._get_attribute(self._SDM_ATT_MAP["MaxStreamsSupported"]) + @property def Name(self): # type: () -> str @@ -756,7 +771,7 @@ def Type(self): """ Returns ------- - - str(ethernet | ethernetvm | ethernetFcoe | atm | pos | tenGigLan | tenGigLanFcoe | fortyGigLan | fortyGigLanFcoe | tenGigWan | tenGigWanFcoe | hundredGigLan | hundredGigLanFcoe | tenFortyHundredGigLan | tenFortyHundredGigLanFcoe | fc | ethernetImpairment | novusHundredGigLan | novusHundredGigLanFcoe | novusTenGigLan | novusTenGigLanFcoe | krakenFourHundredGigLan | krakenFourHundredGigLanFcoe | aresOneFourHundredGigLan | aresOneFourHundredGigLanFcoe | uhdOneHundredGigLan | novus5GTenTwentyFiveGigLan | novus5GTenTwentyFiveGigLanFcoe | starFourHundredGigLan | starFourHundredGigLanFcoe): The type of port selection. + - str(ethernet | ethernetvm | ethernetFcoe | atm | pos | tenGigLan | tenGigLanFcoe | fortyGigLan | fortyGigLanFcoe | tenGigWan | tenGigWanFcoe | hundredGigLan | hundredGigLanFcoe | tenFortyHundredGigLan | tenFortyHundredGigLanFcoe | fc | ethernetImpairment | novusHundredGigLan | novusHundredGigLanFcoe | novusTenGigLan | novusTenGigLanFcoe | krakenFourHundredGigLan | krakenFourHundredGigLanFcoe | aresOneFourHundredGigLan | aresOneFourHundredGigLanFcoe | uhdOneHundredGigLan | novus5GTenTwentyFiveGigLan | novus5GTenTwentyFiveGigLanFcoe | starFourHundredGigLan | starFourHundredGigLanFcoe | ravenEightHundredGigLan | ravenEightHundredGigLanFcoe | aresOneEightHundredGigLanQddC | aresOneEightHundredGigLanQddCFcoe): The type of port selection. """ return self._get_attribute(self._SDM_ATT_MAP["Type"]) @@ -822,7 +837,7 @@ def update( - TransmitIgnoreLinkStatus (bool): If true, the port ingores the link status when transmitting data. - TxGapControlMode (str(fixedMode | averageMode)): This object controls the Gap Control mode of the port. - TxMode (str(sequential | interleaved | sequentialCoarse | interleavedCoarse | packetImpairment)): The transmit mode. - - Type (str(ethernet | ethernetvm | ethernetFcoe | atm | pos | tenGigLan | tenGigLanFcoe | fortyGigLan | fortyGigLanFcoe | tenGigWan | tenGigWanFcoe | hundredGigLan | hundredGigLanFcoe | tenFortyHundredGigLan | tenFortyHundredGigLanFcoe | fc | ethernetImpairment | novusHundredGigLan | novusHundredGigLanFcoe | novusTenGigLan | novusTenGigLanFcoe | krakenFourHundredGigLan | krakenFourHundredGigLanFcoe | aresOneFourHundredGigLan | aresOneFourHundredGigLanFcoe | uhdOneHundredGigLan | novus5GTenTwentyFiveGigLan | novus5GTenTwentyFiveGigLanFcoe | starFourHundredGigLan | starFourHundredGigLanFcoe)): The type of port selection. + - Type (str(ethernet | ethernetvm | ethernetFcoe | atm | pos | tenGigLan | tenGigLanFcoe | fortyGigLan | fortyGigLanFcoe | tenGigWan | tenGigWanFcoe | hundredGigLan | hundredGigLanFcoe | tenFortyHundredGigLan | tenFortyHundredGigLanFcoe | fc | ethernetImpairment | novusHundredGigLan | novusHundredGigLanFcoe | novusTenGigLan | novusTenGigLanFcoe | krakenFourHundredGigLan | krakenFourHundredGigLanFcoe | aresOneFourHundredGigLan | aresOneFourHundredGigLanFcoe | uhdOneHundredGigLan | novus5GTenTwentyFiveGigLan | novus5GTenTwentyFiveGigLanFcoe | starFourHundredGigLan | starFourHundredGigLanFcoe | ravenEightHundredGigLan | ravenEightHundredGigLanFcoe | aresOneEightHundredGigLanQddC | aresOneEightHundredGigLanQddCFcoe)): The type of port selection. - UseGlobalSettings (bool): Enables/Disables use of global settings instead of local settings on port Raises @@ -863,7 +878,7 @@ def add( - TransmitIgnoreLinkStatus (bool): If true, the port ingores the link status when transmitting data. - TxGapControlMode (str(fixedMode | averageMode)): This object controls the Gap Control mode of the port. - TxMode (str(sequential | interleaved | sequentialCoarse | interleavedCoarse | packetImpairment)): The transmit mode. - - Type (str(ethernet | ethernetvm | ethernetFcoe | atm | pos | tenGigLan | tenGigLanFcoe | fortyGigLan | fortyGigLanFcoe | tenGigWan | tenGigWanFcoe | hundredGigLan | hundredGigLanFcoe | tenFortyHundredGigLan | tenFortyHundredGigLanFcoe | fc | ethernetImpairment | novusHundredGigLan | novusHundredGigLanFcoe | novusTenGigLan | novusTenGigLanFcoe | krakenFourHundredGigLan | krakenFourHundredGigLanFcoe | aresOneFourHundredGigLan | aresOneFourHundredGigLanFcoe | uhdOneHundredGigLan | novus5GTenTwentyFiveGigLan | novus5GTenTwentyFiveGigLanFcoe | starFourHundredGigLan | starFourHundredGigLanFcoe)): The type of port selection. + - Type (str(ethernet | ethernetvm | ethernetFcoe | atm | pos | tenGigLan | tenGigLanFcoe | fortyGigLan | fortyGigLanFcoe | tenGigWan | tenGigWanFcoe | hundredGigLan | hundredGigLanFcoe | tenFortyHundredGigLan | tenFortyHundredGigLanFcoe | fc | ethernetImpairment | novusHundredGigLan | novusHundredGigLanFcoe | novusTenGigLan | novusTenGigLanFcoe | krakenFourHundredGigLan | krakenFourHundredGigLanFcoe | aresOneFourHundredGigLan | aresOneFourHundredGigLanFcoe | uhdOneHundredGigLan | novus5GTenTwentyFiveGigLan | novus5GTenTwentyFiveGigLanFcoe | starFourHundredGigLan | starFourHundredGigLanFcoe | ravenEightHundredGigLan | ravenEightHundredGigLanFcoe | aresOneEightHundredGigLanQddC | aresOneEightHundredGigLanQddCFcoe)): The type of port selection. - UseGlobalSettings (bool): Enables/Disables use of global settings instead of local settings on port Returns @@ -913,6 +928,7 @@ def find( Licenses=None, Location=None, MacsecEnabled=None, + MaxStreamsSupported=None, Name=None, ResourceMode=None, RxMode=None, @@ -928,7 +944,7 @@ def find( UseGlobalSettings=None, ValidTxModes=None, ): - # type: (int, str, str, str, str, str, str, str, str, str, str, int, bool, bool, bool, bool, bool, bool, str, str, str, str, str, str, bool, str, str, str, str, str, bool, str, str, bool, str, str, str, bool, List[str]) -> Vport + # type: (int, str, str, str, str, str, str, str, str, str, str, int, bool, bool, bool, bool, bool, bool, str, str, str, str, str, str, bool, str, str, str, str, str, str, bool, str, str, bool, str, str, str, bool, List[str]) -> Vport """Finds and retrieves vport resources from the server. All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve vport resources from the server. @@ -962,6 +978,7 @@ def find( - Licenses (str): Number of licenses. - Location (str): The current format is {chassisIp}/{frontPanelPort}.{fanoutPort} or {chassisIp};{cardId};{portId} for legacy systems. - MacsecEnabled (bool): + - MaxStreamsSupported (str): - Name (str): The description of the port: (1) For an assigned port, the format is: (Port type) (card no.): (port no.) - (chassis name or IP). (2) For an (unassigned) port configuration, the format is: (Port type) Port 00x. - ResourceMode (str): - RxMode (str(capture | measure | captureAndMeasure | packetImpairment)): The receive mode of the virtual port. @@ -973,7 +990,7 @@ def find( - TransmitIgnoreLinkStatus (bool): If true, the port ingores the link status when transmitting data. - TxGapControlMode (str(fixedMode | averageMode)): This object controls the Gap Control mode of the port. - TxMode (str(sequential | interleaved | sequentialCoarse | interleavedCoarse | packetImpairment)): The transmit mode. - - Type (str(ethernet | ethernetvm | ethernetFcoe | atm | pos | tenGigLan | tenGigLanFcoe | fortyGigLan | fortyGigLanFcoe | tenGigWan | tenGigWanFcoe | hundredGigLan | hundredGigLanFcoe | tenFortyHundredGigLan | tenFortyHundredGigLanFcoe | fc | ethernetImpairment | novusHundredGigLan | novusHundredGigLanFcoe | novusTenGigLan | novusTenGigLanFcoe | krakenFourHundredGigLan | krakenFourHundredGigLanFcoe | aresOneFourHundredGigLan | aresOneFourHundredGigLanFcoe | uhdOneHundredGigLan | novus5GTenTwentyFiveGigLan | novus5GTenTwentyFiveGigLanFcoe | starFourHundredGigLan | starFourHundredGigLanFcoe)): The type of port selection. + - Type (str(ethernet | ethernetvm | ethernetFcoe | atm | pos | tenGigLan | tenGigLanFcoe | fortyGigLan | fortyGigLanFcoe | tenGigWan | tenGigWanFcoe | hundredGigLan | hundredGigLanFcoe | tenFortyHundredGigLan | tenFortyHundredGigLanFcoe | fc | ethernetImpairment | novusHundredGigLan | novusHundredGigLanFcoe | novusTenGigLan | novusTenGigLanFcoe | krakenFourHundredGigLan | krakenFourHundredGigLanFcoe | aresOneFourHundredGigLan | aresOneFourHundredGigLanFcoe | uhdOneHundredGigLan | novus5GTenTwentyFiveGigLan | novus5GTenTwentyFiveGigLanFcoe | starFourHundredGigLan | starFourHundredGigLanFcoe | ravenEightHundredGigLan | ravenEightHundredGigLanFcoe | aresOneEightHundredGigLanQddC | aresOneEightHundredGigLanQddCFcoe)): The type of port selection. - UseGlobalSettings (bool): Enables/Disables use of global settings instead of local settings on port - ValidTxModes (list(str[interleaved | interleavedCoarse | packetImpairment | sequential | sequentialCoarse])): diff --git a/version.txt b/version.txt index a5ba93251..db1527897 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -1.1.7 \ No newline at end of file +1.1.8 \ No newline at end of file