Click or drag to resize

ModifyInitiator Class

ModifyInitiator Object containing characteristics of each initiator to modify.
Inheritance Hierarchy
SystemObject
  SolidFire.CoreRpcBase
    SolidFire.Element.ApiModifyInitiator

Namespace:  SolidFire.Element.Api
Assembly:  SolidFire.SDK (in SolidFire.SDK.dll) Version: 12.3.0.0
Syntax
C#
public class ModifyInitiator : RpcBase

The ModifyInitiator type exposes the following members.

Constructors
  NameDescription
Public methodModifyInitiator
Initializes a new instance of the ModifyInitiator class
Top
Properties
  NameDescription
Public propertyAlias
A new friendly name to assign to the initiator.
Public propertyAttributes
A new set of JSON attributes assigned to this initiator.
Public propertyChapUsername
The CHAP username for this initiator. Defaults to the initiator name (IQN) if not specified during creation and "requireChap" is true.
Public propertyInitiatorID
The numeric ID of the initiator to modify.
Public propertyInitiatorSecret
The CHAP secret used for authentication of the initiator. Defaults to a randomly generated secret if not specified during creation and "requireChap" is true.
Public propertyRequireChap
"requireChap" determines if the initiator is required to use CHAP during session login. CHAP is optional if "requireChap" is false.
Public propertyTargetSecret
The CHAP secret used for authentication of the target. Defaults to a randomly generated secret if not specified during creation and "requireChap" is true.
Public propertyVirtualNetworkIDs
The list of virtual network identifiers associated with this initiator. If one or more are defined, this initiator will only be able to login to the specified virtual networks. If no virtual networks are defined this initiator can login to all networks.
Public propertyVolumeAccessGroupID
The ID of the volume access group to which the newly created initiator should be added. If the initiator was previously in a different volume access group, it is removed from the old volume access group. If this key is present but null, the initiator is removed from its current volume access group but not placed in any new volume access group.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Builds a json-enabled string of all the properties and their values in this class.
(Inherited from RpcBase.)
Top
See Also