Class ScriptDummy

Namespace: Skyline.DataMiner.Automation

Assembly: SLManagedAutomation.dll

Represents a script dummy.

public class ScriptDummy : IActionableElement

Inheritance: object

ScriptDummy

Implements: IActionableElement

Extension Methods: TypeExtensions.ChangeType<T>(object)

Remarks

Properties

DmaId: Gets the DataMiner Agent ID.

ElementId: Gets the element ID.

ElementInfo: Gets the Skyline.DataMiner.Net.Messages.ElementInfoEventMessage object.

ElementName: Gets the element name.

Id: Gets the ID.

IsActive: Gets a value indicating whether this element is active.

Name: Gets the name of the dummy.

PollingIP: Gets the polling IP address.

Protocol: Gets the protocol info response message.

ProtocolName: Gets the protocol name.

ProtocolVersion: Gets the protocol version.

Methods

ConnectMatrixCrosspoint(int, int, int): Connects the specified matrix crosspoint.

ConnectMatrixCrosspoint(int, string, string): Connects the specified matrix crosspoint.

ConnectMatrixCrosspoint(string, int, int): Connects the specified matrix crosspoint.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

ConnectMatrixCrosspoint(string, string, string): Connects the specified matrix crosspoint.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

DisconnectMatrixCrosspoint(int, int, int): Disconnects the specified matrix crosspoint.

DisconnectMatrixCrosspoint(int, string, string): Disconnects the specified matrix crosspoint.

DisconnectMatrixCrosspoint(string, int, int): Disconnects the specified matrix crosspoint.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

DisconnectMatrixCrosspoint(string, string, string): Disconnects the specified matrix crosspoint.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

FindDisplayKey(int, string): Gets the display key that corresponds with the specified primary key.

FindDisplayKey(string, string): Gets the display key that corresponds with the specified primary key.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

FindParameterID(string): Gets the ID that corresponds with the specified parameter name.

note
Please use a library with the mapping between parameter Description and ID in your script instead.

FindParameterID(string, bool): Gets the ID that corresponds with the specified parameter name.

note
Please use a library with the mapping between parameter Description and ID in your script instead.

FindPrimaryKey(int, string): Gets the primary key that corresponds with the specified display key.

FindPrimaryKey(string, string): Gets the primary key that corresponds with the specified display key.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

FindView(): Gets the name of the view this element is a member of.

FindViews(): Gets the names of all the views this element is a member of.

FindWriteParameterID(string): Gets the ID of the write parameter with the specified name.

note
Please use a library with the mapping between parameter Description and ID in your script instead.

GetDisplayValue(int, string): Gets the display value that corresponds with the specified raw value of the specified parameter.

GetDisplayValue(string, string): Gets the display value that corresponds with the specified raw value of the specified parameter.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

GetExternalInterfaces(): Retrieves the external interfaces of this dummy.

GetInterface(int): Retrieves the specified DCF interface.

GetInterface(string): Retrieves the specified DCF interface.

GetInterfaces(): Retrieves all DCF interfaces of this dummy.

GetInterfacesByName(string, bool): Retrieves the DCF interfaces that match the specified filter.

GetInterfacesByType(string): Retrieves the DCF interfaces of the specified interface type.

GetInternalInterfaces(): Retrieves the internal interfaces of this dummy.

GetMatrixInputForOutput(int, int): Gets the input that is connected to the specified output.

GetMatrixInputForOutput(int, string): Gets the input that is connected to the specified output.

GetMatrixInputForOutput(string, int): Gets the input that is connected to the specified output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

GetMatrixInputForOutput(string, string): Gets the input that is connected to the specified output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

GetParameter(int): Gets the value of the specified parameter.

GetParameter(int, string): Gets the value of the specified table cell.

GetParameter(string): Gets the value of the specified parameter.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

GetParameter(string, string): Gets the value of the specified table cell.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

GetParameterByPrimaryKey(int, string): Gets the value of the specified table cell using the primary key.

GetParameterByPrimaryKey(string, string): Gets the value of the specified table cell using the primary key.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

GetParameterDisplay(int): Gets the display value of the specified standalone parameter.

GetParameterDisplay(int, string): Gets the display value of the specified table cell.

GetParameterDisplay(string): Gets the display value of the specified standalone parameter.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

GetParameterDisplay(string, string): Gets the display value of the specified table cell.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

GetParameterDisplayByPrimaryKey(int, string): Gets the display value of the specified table cell using the column name and row primary key.

GetParameterDisplayByPrimaryKey(string, string): Gets the display value of the specified table cell using the column name and row primary key.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

GetPropertyValue(string): Gets the value of the specified element property.

GetRawValue(int, string): Gets the value that corresponds with the specified display value of the specified parameter.

GetRawValue(string, string): Gets the value that corresponds with the specified display value of the specified parameter.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

GetReadParameterIDFromWrite(int): Gets the ID of the read parameter that corresponds with the specified write parameter ID.

GetReadParameterIDFromWrite(string): Gets the ID of the read parameter that corresponds with the specified write parameter ID.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

GetSpectrumPreset(string): Gets an object that can be used to change the specified preset.

GetTableDisplayKeys(int): Gets the display keys of the specified table.

GetTableDisplayKeys(string): Gets the display keys of the specified table.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

GetTableKeyMappings(int): Gets the primary key to display key map of the specified table.

GetTableKeyMappings(string): Gets the primary key to display key map of the specified table.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

GetTablePrimaryKeys(int): Gets the primary keys of the specified table.

GetTablePrimaryKeys(string): Gets the primary keys of the specified table.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

GetWriteParameterIDFromRead(int): Gets the ID of the write parameter that corresponds with the specified read parameter.

GetWriteParameterIDFromRead(string): Gets the ID of the write parameter that corresponds with the specified read parameter.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

HasProperty(string): Returns a value indicating whether the element has a property with the specified name.

IsMatrixCrosspointConnected(int, int, int): Returns a value indicating whether the specified matrix crosspoint is connected.

IsMatrixCrosspointConnected(int, string, string): Returns a value indicating whether the specified matrix crosspoint is connected.

IsMatrixCrosspointConnected(string, int, int): Returns a value indicating whether the specified matrix crosspoint is connected.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

IsMatrixCrosspointConnected(string, string, string): Returns a value indicating whether the specified matrix crosspoint is connected.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

Mask(string): Masks the element that is linked to the dummy.

Mask(string, int): Masks the element that is linked to the dummy for the specified period of time.

MaskUntilNormal(string): Masks the element that is linked to the dummy until all its alarms have been cleared.

MatrixEnableInputLine(int, int, bool): Enables or disables the specified matrix input.

MatrixEnableInputLine(int, string, bool): Enables or disables the specified matrix input.

MatrixEnableInputLine(string, int, bool): Enables or disables the specified matrix input.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixEnableInputLine(string, string, bool): Enables or disables the specified matrix input.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixEnableLine(int, bool, int, bool): Enables or disables the specified matrix input or output.

MatrixEnableLine(int, bool, string, bool): Enables or disables the specified matrix input or output.

MatrixEnableLine(string, bool, int, bool): Enables or disables the specified matrix input or output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixEnableLine(string, bool, string, bool): Enables or disables the specified matrix input or output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixEnableOutputLine(int, int, bool): Enables or disables the specified matrix output.

MatrixEnableOutputLine(int, string, bool): Enables or disables the specified matrix output.

MatrixEnableOutputLine(string, int, bool): Enables or disables the specified matrix output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixEnableOutputLine(string, string, bool): Enables or disables the specified matrix output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixGetFollowMode(int, int): Gets a value indicating whether "follow mode" is enabled on the specified matrix output.

MatrixGetFollowMode(int, string): Gets a value indicating whether "follow mode" is enabled on the specified matrix output.

MatrixGetFollowMode(string, int): Gets a value indicating whether "follow mode" is enabled on the specified matrix output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixGetFollowMode(string, string): Gets a value indicating whether "follow mode" is enabled on the specified matrix output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixGetIndexFromLabel(int, bool, string): Gets the index of the input or output that corresponds with the specified input or output label.

MatrixGetIndexFromLabel(string, bool, string): Gets the index of the input or output that corresponds with the specified input or output label.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixGetInputIndexFromInputLabel(int, string): Gets the index of the input that corresponds with the specified input label.

MatrixGetInputIndexFromInputLabel(string, string): Gets the index of the input that corresponds with the specified input label.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixGetInputLabel(int, int): Gets the label of the specified matrix input.

MatrixGetInputLabel(string, int): Gets the label of the specified matrix input.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixGetInputLockMode(int, int): Gets a value indicating whether the specified matrix input is locked.

MatrixGetInputLockMode(int, string): Gets a value indicating whether the specified matrix input is locked.

MatrixGetInputLockMode(string, int): Gets a value indicating whether the specified matrix input is locked.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixGetInputLockMode(string, string): Gets a value indicating whether the specified matrix input is locked.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixGetLabel(int, bool, int): Gets the label of the specified matrix input or output.

MatrixGetLabel(string, bool, int): Gets the label of the specified matrix input or output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixGetLockMode(int, bool, int): Gets a value indicating whether the specified input or output is locked.

MatrixGetLockMode(int, bool, string): Gets a value indicating whether the specified input or output is locked.

MatrixGetLockMode(string, bool, int): Gets a value indicating whether the specified input or output is locked.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixGetLockMode(string, bool, string): Gets a value indicating whether the specified input or output is locked.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixGetOutputIndexFromOutputLabel(int, string): Gets the index of the output that corresponds with the specified output label.

MatrixGetOutputIndexFromOutputLabel(string, string): Gets the index of the output that corresponds with the specified output label.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixGetOutputLabel(int, int): Gets the label of the specified matrix output.

MatrixGetOutputLabel(string, int): Gets the label of the specified matrix output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixGetOutputLockMode(int, int): Gets a value indicating whether the specified matrix output is locked.

MatrixGetOutputLockMode(int, string): Gets a value indicating whether the specified matrix output is locked.

MatrixGetOutputLockMode(string, int): Gets a value indicating whether the specified matrix output is locked.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixGetOutputLockMode(string, string): Gets a value indicating whether the specified matrix output is locked.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixIsInputLineEnabled(int, int): Gets a value indicating whether the specified matrix input is enabled.

MatrixIsInputLineEnabled(int, string): Gets a value indicating whether the specified matrix input is enabled.

MatrixIsInputLineEnabled(string, int): Gets a value indicating whether the specified matrix input is enabled.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixIsInputLineEnabled(string, string): Gets a value indicating whether the specified matrix input is enabled.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixIsLineEnabled(int, bool, int): Gets a value indicating whether the specified matrix input or output is enabled.

MatrixIsLineEnabled(int, bool, string): Gets a value indicating whether the specified matrix input or output is enabled.

MatrixIsLineEnabled(string, bool, int): Gets a value indicating whether the specified matrix input or output is enabled.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixIsLineEnabled(string, bool, string): Gets a value indicating whether the specified matrix input or output is enabled.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixIsOutputLineEnabled(int, int): Gets a value indicating whether the specified matrix output is enabled.

MatrixIsOutputLineEnabled(int, string): Gets a value indicating whether the specified matrix output is enabled.

MatrixIsOutputLineEnabled(string, int): Gets a value indicating whether the specified matrix output is enabled.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixIsOutputLineEnabled(string, string): Gets a value indicating whether the specified matrix output is enabled.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetFollowMaster(int, int, int): Configures a slave output to follow a master output on the specified matrix.

MatrixSetFollowMaster(int, string, string): Configures a slave output to follow a master output on the specified matrix.

MatrixSetFollowMaster(string, int, int): Configures a slave output to follow a master output on the specified matrix.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetFollowMaster(string, string, string): Configures a slave output to follow a master output on the specified matrix.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetFollowMode(int, int, bool): Enables or disables the ‘follow mode’ of the specified matrix output.

MatrixSetFollowMode(int, string, bool): Enables or disables the ‘follow mode’ of the specified matrix output.

MatrixSetFollowMode(string, int, bool): Enables or disables the ‘follow mode’ of the specified matrix output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetFollowMode(string, string, bool): Enables or disables the ‘follow mode’ of the specified matrix output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetInputLabel(int, int, string): Sets the label of the specified input.

MatrixSetInputLabel(int, string, string): Sets the label of the specified input.

MatrixSetInputLabel(string, int, string): Sets the label of the specified input.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetInputLabel(string, string, string): Sets the label of the specified input.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetInputLockMode(int, int, bool): Locks or unlocks the specified matrix input.

MatrixSetInputLockMode(int, string, bool): Locks or unlocks the specified matrix input.

MatrixSetInputLockMode(string, int, bool): Locks or unlocks the specified matrix input.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetInputLockMode(string, string, bool): Locks or unlocks the specified matrix input.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetLabel(int, bool, int, string): Sets the label of the specified matrix input or output.

MatrixSetLabel(int, bool, string, string): Sets the label of the specified matrix input or output.

MatrixSetLabel(string, bool, int, string): Sets the label of the specified matrix input or output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetLabel(string, bool, string, string): Sets the label of the specified matrix input or output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetLockMode(int, bool, int, bool): Locks or unlocks the specified matrix input or output.

MatrixSetLockMode(int, bool, string, bool): Locks or unlocks the specified matrix input or output.

MatrixSetLockMode(string, bool, int, bool): Locks or unlocks the specified matrix input or output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetLockMode(string, bool, string, bool): Locks or unlocks the specified matrix input or output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetOutputLabel(int, int, string): Sets the label of the specified matrix output.

MatrixSetOutputLabel(int, string, string): Sets the label of the specified matrix output.

MatrixSetOutputLabel(string, int, string): Sets the label of the specified matrix output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetOutputLabel(string, string, string): Sets the label of the specified matrix output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetOutputLockMode(int, int, bool): Locks or unlocks the specified matrix output.

MatrixSetOutputLockMode(int, string, bool): Locks or unlocks the specified matrix output.

MatrixSetOutputLockMode(string, int, bool): Locks or unlocks the specified matrix output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixSetOutputLockMode(string, string, bool): Locks or unlocks the specified matrix output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixStopBeingMaster(int, int): Stops the specified matrix output from being a master output.

MatrixStopBeingMaster(int, string): Stops the specified matrix output from being a master output.

MatrixStopBeingMaster(string, int): Stops the specified matrix output from being a master output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

MatrixStopBeingMaster(string, string): Stops the specified matrix output from being a master output.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

Pause(): Pauses the element that is linked to the dummy.

RemoveAlarmTemplate(): Removes the link between this element and the alarm template that is assigned to it. This sets the element to “Not Monitored”.

RemoveTrendTemplate(): Removes the link between an element and the trend template that is assigned to it. This disables trending for the dummy.

Restart(): Restarts the element that is linked to the dummy.

SetAlarmTemplate(string): Assigns the specified alarm template to the dummy.

SetParameter(int, object): Sets the value of the specified parameter.

SetParameter(int, string, object): Sets the value of the specified cell.

SetParameter(string, object): Sets the value of the specified parameter.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

SetParameter(string, string, object): Sets the value of the specified cell.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

SetParameterByPrimaryKey(int, string, object): Sets the value of a cell specified using the primary key instead of the display key.

SetParameterByPrimaryKey(string, string, object): Sets the value of a cell specified using the primary key instead of the display key.

note
Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

SetPropertyValue(string, string): Sets the value of a writable element property.

SetTrendTemplate(string): Assigns the specified trend template to the dummy.

SpectrumDisableMonitor(int): Disables a spectrum monitor.

SpectrumDisableMonitor(string): Disables a spectrum monitor.

SpectrumEnableMonitor(int): Enables a spectrum monitor.

SpectrumEnableMonitor(string): Enables a spectrum monitor.

SpectrumFindMeasurementPointIdByName(string): Gets the ID that corresponds with the specified spectrum measurement point name.

SpectrumFindMonitorIdByName(string): Gets the ID that corresponds with the specified spectrum monitor name.

SpectrumIsMonitorEnabled(int): Returns a value indicating whether the specified spectrum monitor is enabled.

SpectrumIsMonitorEnabled(string): Returns a value indicating whether the specified spectrum monitor is enabled.

SpectrumSelectMeasurementPointsForMonitor(int, params int[]): Selects the measurement point(s) on which a spectrum monitor has to be executed.

SpectrumSelectMeasurementPointsForMonitor(string, params string[]): Selects the measurement point(s) on which a spectrum monitor has to be executed.

Start(): Starts the element that is linked to the dummy.

Stop(): Stops the element that is linked to the dummy.

Unmask(): Unmasks the element that is linked to the dummy.

Table of Contents

Class ScriptDummy

Remarks

Properties

Methods

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note

note