text: # 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. 
  from ixnetwork_restpy.base import Base
  from ixnetwork_restpy.files import Files
  
  
  class Lagportstaticlag(Base):
      """
      The Lagportstaticlag class encapsulates a list of lagportstaticlag resources that are managed by the user.
      A list of resources can be retrieved from the server using the Lagportstaticlag.find() method.
      The list can be managed by using the Lagportstaticlag.add() and Lagportstaticlag.remove() methods.
      """
  
      __slots__ = ()
      _SDM_NAME = 'lagportstaticlag'
      _SDM_ATT_MAP = {
          'Active': 'active',
          'ConnectedVia': 'connectedVia',
          'Count': 'count',
          'DescriptiveName': 'descriptiveName',
          'Errors': 'errors',
          'LagId': 'lagId',
          'Multiplier': 'multiplier',
          'Name': 'name',
          'SessionStatus': 'sessionStatus',
          'StackedLayers': 'stackedLayers',
          'StateCounts': 'stateCounts',
          'Status': 'status',
      }
  
      def __init__(self, parent):
          super(Lagportstaticlag, self).__init__(parent)
  
      @property
      def Active(self):
          """
          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 ConnectedVia(self):
          """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):
          self._set_attribute(self._SDM_ATT_MAP['ConnectedVia'], value)
  
      @property
      def Count(self):
          """
          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):
          """
          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 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 LagId(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): LAG ID
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['LagId']))
  
      @property
      def Multiplier(self):
          """
          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):
          self._set_attribute(self._SDM_ATT_MAP['Multiplier'], value)
  
      @property
      def Name(self):
          """
          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):
          self._set_attribute(self._SDM_ATT_MAP['Name'], value)
  
      @property
      def SessionStatus(self):
          """
          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):
          """
          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):
          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 Status(self):
          """
          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'])
  
      def update(self, ConnectedVia=None, Multiplier=None, Name=None, StackedLayers=None):
          """Updates lagportstaticlag 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.
          - Multiplier (number): Number of layer instances per parent instance (multiplier)
          - Name (str): Name of NGPF element, guaranteed to be unique in Scenario
          - 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, ConnectedVia=None, Multiplier=None, Name=None, StackedLayers=None):
          """Adds a new lagportstaticlag 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.
          - Multiplier (number): Number of layer instances per parent instance (multiplier)
          - Name (str): Name of NGPF element, guaranteed to be unique in Scenario
          - 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 lagportstaticlag resources using find and the newly added lagportstaticlag 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 lagportstaticlag 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, Multiplier=None, Name=None, SessionStatus=None, StackedLayers=None, StateCounts=None, Status=None):
          """Finds and retrieves lagportstaticlag resources from the server.
  
          All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve lagportstaticlag 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 lagportstaticlag 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.
          - Errors (list(dict(arg1:str[None | /api/v1/sessions/1/ixnetwork//.../*],arg2:list[str]))): A list of errors that have occurred
          - Multiplier (number): Number of layer instances per parent instance (multiplier)
          - Name (str): Name of NGPF element, guaranteed to be unique in Scenario
          - 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.
  
          Returns
          -------
          - self: This instance with matching lagportstaticlag 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 lagportstaticlag data from the server.
  
          Args
          ----
          - href (str): An href to the instance to be retrieved
  
          Returns
          -------
          - self: This instance with the lagportstaticlag 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, LagId=None):
          """Base class infrastructure that gets a list of lagportstaticlag 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
          - LagId (str): optional regex of lagId
  
          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())
  
      def Abort(self, *args, **kwargs):
          """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(SessionIndices=list)
          --------------------------
          - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3
  
          abort(SessionIndices=string)
          ----------------------------
          - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12
  
          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):
          """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(SessionIndices=list)
          --------------------------------
          - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3
  
          restartDown(SessionIndices=string)
          ----------------------------------
          - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12
  
          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):
          """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(SessionIndices=list)
          --------------------------
          - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3
  
          start(SessionIndices=string)
          ----------------------------
          - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12
  
          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):
          """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(SessionIndices=list)
          -------------------------
          - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3
  
          stop(SessionIndices=string)
          ---------------------------
          - SessionIndices (str): This parameter requires a string of session numbers 1-4;6;7-12
  
          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)
  