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 OspfPseudoRouterStubNetworks(Base):
      """Simulated Router Information
      The OspfPseudoRouterStubNetworks class encapsulates a list of ospfPseudoRouterStubNetworks resources that are managed by the system.
      A list of resources can be retrieved from the server using the OspfPseudoRouterStubNetworks.find() method.
      """
  
      __slots__ = ()
      _SDM_NAME = 'ospfPseudoRouterStubNetworks'
      _SDM_ATT_MAP = {
          'Active': 'active',
          'Algorithm': 'algorithm',
          'ConfigureSIDIndexLabel': 'configureSIDIndexLabel',
          'Count': 'count',
          'DescriptiveName': 'descriptiveName',
          'EFlag': 'eFlag',
          'LFlag': 'lFlag',
          'MFlag': 'mFlag',
          'Metric': 'metric',
          'Name': 'name',
          'NetworkAddress': 'networkAddress',
          'NpFlag': 'npFlag',
          'PrefixLength': 'prefixLength',
          'RangeSize': 'rangeSize',
          'SidIndexLabel': 'sidIndexLabel',
          'VFlag': 'vFlag',
      }
  
      def __init__(self, parent):
          super(OspfPseudoRouterStubNetworks, self).__init__(parent)
  
      @property
      def Active(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Whether this is to be advertised or not
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['Active']))
  
      @property
      def Algorithm(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Algorithm
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['Algorithm']))
  
      @property
      def ConfigureSIDIndexLabel(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Configure SID/Index/Label
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['ConfigureSIDIndexLabel']))
  
      @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 EFlag(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Explicit-Null Flag
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['EFlag']))
  
      @property
      def LFlag(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Local or Global Flag
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['LFlag']))
  
      @property
      def MFlag(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Mapping Server Flag
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['MFlag']))
  
      @property
      def Metric(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Metric
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['Metric']))
  
      @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 NetworkAddress(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Network addresses of the simulated IPv4 network
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['NetworkAddress']))
  
      @property
      def NpFlag(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): No-PHP Flag
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['NpFlag']))
  
      @property
      def PrefixLength(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Prefix
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['PrefixLength']))
  
      @property
      def RangeSize(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Range Size
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['RangeSize']))
  
      @property
      def SidIndexLabel(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): SID/Index/Label
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['SidIndexLabel']))
  
      @property
      def VFlag(self):
          """
          Returns
          -------
          - obj(ixnetwork_restpy.multivalue.Multivalue): Value or Index Flag
          """
          from ixnetwork_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['VFlag']))
  
      def update(self, Name=None):
          """Updates ospfPseudoRouterStubNetworks 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):
          """Finds and retrieves ospfPseudoRouterStubNetworks resources from the server.
  
          All named parameters are evaluated on the server using regex. The named parameters can be used to selectively retrieve ospfPseudoRouterStubNetworks 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 ospfPseudoRouterStubNetworks 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 ospfPseudoRouterStubNetworks 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 ospfPseudoRouterStubNetworks data from the server.
  
          Args
          ----
          - href (str): An href to the instance to be retrieved
  
          Returns
          -------
          - self: This instance with the ospfPseudoRouterStubNetworks 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, Algorithm=None, ConfigureSIDIndexLabel=None, EFlag=None, LFlag=None, MFlag=None, Metric=None, NetworkAddress=None, NpFlag=None, PrefixLength=None, RangeSize=None, SidIndexLabel=None, VFlag=None):
          """Base class infrastructure that gets a list of ospfPseudoRouterStubNetworks 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
          - Algorithm (str): optional regex of algorithm
          - ConfigureSIDIndexLabel (str): optional regex of configureSIDIndexLabel
          - EFlag (str): optional regex of eFlag
          - LFlag (str): optional regex of lFlag
          - MFlag (str): optional regex of mFlag
          - Metric (str): optional regex of metric
          - NetworkAddress (str): optional regex of networkAddress
          - NpFlag (str): optional regex of npFlag
          - PrefixLength (str): optional regex of prefixLength
          - RangeSize (str): optional regex of rangeSize
          - SidIndexLabel (str): optional regex of sidIndexLabel
          - VFlag (str): optional regex of vFlag
  
          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):
          """Executes the abort operation on the server.
  
          Abort CPF control plane (equals to demote to kUnconfigured state).
  
          Raises
          ------
          - NotFoundError: The requested resource does not exist on the server
          - ServerError: The server has encountered an uncategorized error condition
          """
          payload = { "Arg1": self }
          return self._execute('abort', payload=payload, response_object=None)
  
      def Advertise(self, *args, **kwargs):
          """Executes the advertise operation on the server.
  
          Advertise selected routes
  
          The IxNetwork model allows for multiple method Signatures with the same name while python does not.
  
          advertise(SessionIndices=list)
          ------------------------------
          - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3
  
          advertise(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('advertise', payload=payload, response_object=None)
  
      def Start(self):
          """Executes the start operation on the server.
  
          Start CPF control plane (equals to promote to negotiated state).
  
          Raises
          ------
          - NotFoundError: The requested resource does not exist on the server
          - ServerError: The server has encountered an uncategorized error condition
          """
          payload = { "Arg1": self }
          return self._execute('start', payload=payload, response_object=None)
  
      def Stop(self):
          """Executes the stop operation on the server.
  
          Stop CPF control plane (equals to demote to PreValidated-DoDDone state).
  
          Raises
          ------
          - NotFoundError: The requested resource does not exist on the server
          - ServerError: The server has encountered an uncategorized error condition
          """
          payload = { "Arg1": self }
          return self._execute('stop', payload=payload, response_object=None)
  
      def Withdraw(self, *args, **kwargs):
          """Executes the withdraw operation on the server.
  
          Withdraw selected routes
  
          The IxNetwork model allows for multiple method Signatures with the same name while python does not.
  
          withdraw(SessionIndices=list)
          -----------------------------
          - SessionIndices (list(number)): This parameter requires an array of session numbers 1 2 3
  
          withdraw(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('withdraw', payload=payload, response_object=None)
  