# MIT LICENSE
#
# Copyright 1997 - 2019 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 EgtpServerOptions(Base):
	"""The EgtpServerOptions class encapsulates a user managed egtpServerOptions node in the ixnetwork hierarchy.

	An instance of the class can be obtained by accessing the EgtpServerOptions property from a parent instance.
	The internal properties list will be empty when the property is accessed and is populated from the server using the find method.
	The internal properties list can be managed by the user by using the add and remove methods.
	"""

	__slots__ = ()
	_SDM_NAME = 'egtpServerOptions'

	def __init__(self, parent):
		super(EgtpServerOptions, self).__init__(parent)

	@property
	def DistributeUserPlaneIps(self):
		"""Distribute L7 user plane IP addresses across all assigned Ixia ports.

		Returns:
			bool
		"""
		return self._get_attribute('distributeUserPlaneIps')
	@DistributeUserPlaneIps.setter
	def DistributeUserPlaneIps(self, value):
		self._set_attribute('distributeUserPlaneIps', value)

	@property
	def EnableCreateBearerTFTHack(self):
		"""Send the first port received from the peer activity in the Create Bearer Request TFT.

		Returns:
			bool
		"""
		return self._get_attribute('enableCreateBearerTFTHack')
	@EnableCreateBearerTFTHack.setter
	def EnableCreateBearerTFTHack(self, value):
		self._set_attribute('enableCreateBearerTFTHack', value)

	@property
	def EnableDynamicAllocation(self):
		"""Enable dynamic allocation of UEs and sessions on PGW.

		Returns:
			bool
		"""
		return self._get_attribute('enableDynamicAllocation')
	@EnableDynamicAllocation.setter
	def EnableDynamicAllocation(self, value):
		self._set_attribute('enableDynamicAllocation', value)

	@property
	def ObjectId(self):
		"""Unique identifier for this object

		Returns:
			str
		"""
		return self._get_attribute('objectId')

	@property
	def PcpuLogLevel(self):
		"""PCPU log level

		Returns:
			str
		"""
		return self._get_attribute('pcpuLogLevel')
	@PcpuLogLevel.setter
	def PcpuLogLevel(self, value):
		self._set_attribute('pcpuLogLevel', value)

	@property
	def PublishStatistics(self):
		"""Publish statistics for SGW.

		Returns:
			bool
		"""
		return self._get_attribute('publishStatistics')
	@PublishStatistics.setter
	def PublishStatistics(self, value):
		self._set_attribute('publishStatistics', value)

	def update(self, DistributeUserPlaneIps=None, EnableCreateBearerTFTHack=None, EnableDynamicAllocation=None, PcpuLogLevel=None, PublishStatistics=None):
		"""Updates a child instance of egtpServerOptions on the server.

		Args:
			DistributeUserPlaneIps (bool): Distribute L7 user plane IP addresses across all assigned Ixia ports.
			EnableCreateBearerTFTHack (bool): Send the first port received from the peer activity in the Create Bearer Request TFT.
			EnableDynamicAllocation (bool): Enable dynamic allocation of UEs and sessions on PGW.
			PcpuLogLevel (str): PCPU log level
			PublishStatistics (bool): Publish statistics for SGW.

		Raises:
			ServerError: The server has encountered an uncategorized error condition
		"""
		self._update(locals())

	def add(self, DistributeUserPlaneIps=None, EnableCreateBearerTFTHack=None, EnableDynamicAllocation=None, PcpuLogLevel=None, PublishStatistics=None):
		"""Adds a new egtpServerOptions node on the server and retrieves it in this instance.

		Args:
			DistributeUserPlaneIps (bool): Distribute L7 user plane IP addresses across all assigned Ixia ports.
			EnableCreateBearerTFTHack (bool): Send the first port received from the peer activity in the Create Bearer Request TFT.
			EnableDynamicAllocation (bool): Enable dynamic allocation of UEs and sessions on PGW.
			PcpuLogLevel (str): PCPU log level
			PublishStatistics (bool): Publish statistics for SGW.

		Returns:
			self: This instance with all currently retrieved egtpServerOptions data using find and the newly added egtpServerOptions data available through an iterator or index

		Raises:
			ServerError: The server has encountered an uncategorized error condition
		"""
		return self._create(locals())

	def remove(self):
		"""Deletes all the egtpServerOptions data in this instance from 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, DistributeUserPlaneIps=None, EnableCreateBearerTFTHack=None, EnableDynamicAllocation=None, ObjectId=None, PcpuLogLevel=None, PublishStatistics=None):
		"""Finds and retrieves egtpServerOptions data from the server.

		All named parameters support regex and can be used to selectively retrieve egtpServerOptions data from the server.
		By default the find method takes no parameters and will retrieve all egtpServerOptions data from the server.

		Args:
			DistributeUserPlaneIps (bool): Distribute L7 user plane IP addresses across all assigned Ixia ports.
			EnableCreateBearerTFTHack (bool): Send the first port received from the peer activity in the Create Bearer Request TFT.
			EnableDynamicAllocation (bool): Enable dynamic allocation of UEs and sessions on PGW.
			ObjectId (str): Unique identifier for this object
			PcpuLogLevel (str): PCPU log level
			PublishStatistics (bool): Publish statistics for SGW.

		Returns:
			self: This instance with matching egtpServerOptions data retrieved from the server available through an iterator or index

		Raises:
			ServerError: The server has encountered an uncategorized error condition
		"""
		return self._select(locals())

	def read(self, href):
		"""Retrieves a single instance of egtpServerOptions data from the server.

		Args:
			href (str): An href to the instance to be retrieved

		Returns:
			self: This instance with the egtpServerOptions data 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 CustomProtocolStack(self, *args, **kwargs):
		"""Executes the customProtocolStack operation on the server.

		Create custom protocol stack under /vport/protocolStack

		customProtocolStack(Arg2:list, Arg3:enum)
			Args:
				args[0] is Arg2 (list(str)): List of plugin types to be added in the new custom stack
				args[1] is Arg3 (str(kAppend|kMerge|kOverwrite)): Append, merge or overwrite existing protocol stack

		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('customProtocolStack', payload=payload, response_object=None)

	def DisableProtocolStack(self, *args, **kwargs):
		"""Executes the disableProtocolStack operation on the server.

		Disable a protocol under protocolStack using the class name

		disableProtocolStack(Arg2:string)string
			Args:
				args[0] is Arg2 (str): Protocol class name to disable

			Returns:
				str: Status of the exec

		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('disableProtocolStack', payload=payload, response_object=None)

	def EnableProtocolStack(self, *args, **kwargs):
		"""Executes the enableProtocolStack operation on the server.

		Enable a protocol under protocolStack using the class name

		enableProtocolStack(Arg2:string)string
			Args:
				args[0] is Arg2 (str): Protocol class name to enable

			Returns:
				str: Status of the exec

		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('enableProtocolStack', payload=payload, response_object=None)
