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 uhd_restpy.base import Base
  from uhd_restpy.files import Files
  
  
  class NtpServers(Base):
      """NTP Servers
      The NtpServers class encapsulates a required ntpServers resource which will be retrieved from the server every time the property is accessed.
      """
  
      __slots__ = ()
      _SDM_NAME = 'ntpServers'
      _SDM_ATT_MAP = {
          'Active': 'active',
          'AuthDelay': 'authDelay',
          'Authentication': 'authentication',
          'AuthenticationKey': 'authenticationKey',
          'BurstMode': 'burstMode',
          'Count': 'count',
          'DescriptiveName': 'descriptiveName',
          'InitialBurstMode': 'initialBurstMode',
          'IsParentV6': 'isParentV6',
          'KeyId': 'keyId',
          'MaxPollInterval': 'maxPollInterval',
          'MinPollInterval': 'minPollInterval',
          'Name': 'name',
          'ParticipateInClockSelect': 'participateInClockSelect',
          'ServerIPAddress': 'serverIPAddress',
          'ServerIPv6Address': 'serverIPv6Address',
      }
  
      def __init__(self, parent):
          super(NtpServers, self).__init__(parent)
  
      @property
      def Active(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Activate/Deactivate Configuration
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['Active']))
  
      @property
      def AuthDelay(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Authentication Delay (microsecs)
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['AuthDelay']))
  
      @property
      def Authentication(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Authentication Type
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['Authentication']))
  
      @property
      def AuthenticationKey(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Authentication Key
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['AuthenticationKey']))
  
      @property
      def BurstMode(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Burst Mode
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['BurstMode']))
  
      @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 InitialBurstMode(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Initial Burst Mode
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['InitialBurstMode']))
  
      @property
      def IsParentV6(self):
          """
          Returns
          -------
          - bool: Parent v6
          """
          return self._get_attribute(self._SDM_ATT_MAP['IsParentV6'])
      @IsParentV6.setter
      def IsParentV6(self, value):
          self._set_attribute(self._SDM_ATT_MAP['IsParentV6'], value)
  
      @property
      def KeyId(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Key Identifier
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['KeyId']))
  
      @property
      def MaxPollInterval(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Max Poll Interval (log2 seconds)
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['MaxPollInterval']))
  
      @property
      def MinPollInterval(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Min Poll Interval (log2 seconds)
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['MinPollInterval']))
  
      @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 ParticipateInClockSelect(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Participate in Clock Select
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['ParticipateInClockSelect']))
  
      @property
      def ServerIPAddress(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Server IP Address
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['ServerIPAddress']))
  
      @property
      def ServerIPv6Address(self):
          """
          Returns
          -------
          - obj(uhd_restpy.multivalue.Multivalue): Server IPv6 Address
          """
          from uhd_restpy.multivalue import Multivalue
          return Multivalue(self, self._get_attribute(self._SDM_ATT_MAP['ServerIPv6Address']))
  
      def update(self, IsParentV6=None, Name=None):
          """Updates ntpServers 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
          ----
          - IsParentV6 (bool): Parent v6
          - 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 get_device_ids(self, PortNames=None, Active=None, AuthDelay=None, Authentication=None, AuthenticationKey=None, BurstMode=None, InitialBurstMode=None, KeyId=None, MaxPollInterval=None, MinPollInterval=None, ParticipateInClockSelect=None, ServerIPAddress=None, ServerIPv6Address=None):
          """Base class infrastructure that gets a list of ntpServers 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
          - AuthDelay (str): optional regex of authDelay
          - Authentication (str): optional regex of authentication
          - AuthenticationKey (str): optional regex of authenticationKey
          - BurstMode (str): optional regex of burstMode
          - InitialBurstMode (str): optional regex of initialBurstMode
          - KeyId (str): optional regex of keyId
          - MaxPollInterval (str): optional regex of maxPollInterval
          - MinPollInterval (str): optional regex of minPollInterval
          - ParticipateInClockSelect (str): optional regex of participateInClockSelect
          - ServerIPAddress (str): optional regex of serverIPAddress
          - ServerIPv6Address (str): optional regex of serverIPv6Address
  
          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 Start(self, *args, **kwargs):
          """Executes the start operation on the server.
  
          Activate/Enable Ntp Servers
  
          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
  
          start(Arg2=list)list
          --------------------
          - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin.
          - 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('start', payload=payload, response_object=None)
  
      def Stop(self, *args, **kwargs):
          """Executes the stop operation on the server.
  
          Deactivate/Disable selected Ntp Servers
  
          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
  
          stop(Arg2=list)list
          -------------------
          - Arg2 (list(number)): List of indices into the protocol plugin. An empty list indicates all instances in the plugin.
          - 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('stop', payload=payload, response_object=None)
  