Skip to content

Commit

Permalink
"version 1.1.8"
Browse files Browse the repository at this point in the history
  • Loading branch information
vhowdhur committed Jan 16, 2023
1 parent 31cc5e6 commit 82e8a7b
Show file tree
Hide file tree
Showing 188 changed files with 16,511 additions and 958 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
3 changes: 3 additions & 0 deletions RELEASENOTES.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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
Expand All @@ -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.
Expand All @@ -91,24 +137,76 @@ 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
------
- ServerError: The server has encountered an uncategorized error condition
"""
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.
Expand All @@ -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
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ class Preferences(Base):
"ConfigurationAtIxNetworkStartup": "configurationAtIxNetworkStartup",
"ConnectPortsOnLoadConfig": "connectPortsOnLoadConfig",
"DeleteDumpFilesOlderThan": "deleteDumpFilesOlderThan",
"DisableMinimizedScenario": "disableMinimizedScenario",
"DisableProtoSpecificConnectors": "disableProtoSpecificConnectors",
"EnableAutoSave": "enableAutoSave",
"EnableCloudTools": "enableCloudTools",
"EnableDpdkForNewConfig": "enableDpdkForNewConfig",
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -546,6 +578,8 @@ def update(
ConfigurationAtIxNetworkStartup=None,
ConnectPortsOnLoadConfig=None,
DeleteDumpFilesOlderThan=None,
DisableMinimizedScenario=None,
DisableProtoSpecificConnectors=None,
EnableAutoSave=None,
EnableCloudTools=None,
EnableDpdkForNewConfig=None,
Expand All @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -615,6 +651,8 @@ def find(
ConfigurationAtIxNetworkStartup=None,
ConnectPortsOnLoadConfig=None,
DeleteDumpFilesOlderThan=None,
DisableMinimizedScenario=None,
DisableProtoSpecificConnectors=None,
EnableAutoSave=None,
EnableCloudTools=None,
EnableDpdkForNewConfig=None,
Expand All @@ -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.
Expand All @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ class Statistics(Base):
_SDM_NAME = "statistics"
_SDM_ATT_MAP = {
"ForceLegacyPortNameInStats": "forceLegacyPortNameInStats",
"GraphHistoryClockTime": "graphHistoryClockTime",
"PersistenceMode": "persistenceMode",
"SnapshotCSVMode": "snapshotCSVMode",
"SnapshotCSVPath": "snapshotCSVPath",
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 <Chassis/Front Panel Port Number> format. When true, it is in <Chassis/Card/Port> 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
Expand All @@ -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.
Expand All @@ -155,6 +174,7 @@ def find(
Args
----
- ForceLegacyPortNameInStats (bool): When false, IxNetwork statistics show port name in <Chassis/Front Panel Port Number> format. When true, it is in <Chassis/Card/Port> 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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):
"""
Expand Down
Loading

0 comments on commit 82e8a7b

Please sign in to comment.