Proxx.SNMP.dll-Help.xml
<?xml version="1.0" encoding="utf-8"?> <helpItems schema="maml" xmlns="http://msh"> <!-- Cmdlet: Invoke-SnmpGet --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-SnmpGet</command:name> <command:verb>Invoke</command:verb> <command:noun>SnmpGet</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-SnmpGet</maml:name> <!-- Parameter: IpAddress --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Address,ComputerName,IP,Node"> <maml:name>IpAddress</maml:name> <maml:description> <maml:para>Specifies the address of the device.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Oid --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Oid</maml:name> <maml:description> <maml:para>Specifies the object identifier (OID). One or more object identifiers (OIDs) may be given as arguments.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Community --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Community</maml:name> <maml:description> <maml:para>Specifies community string for SNMP communication. The default is "public".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>public</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies port used for SNMP communication. The default is "161".</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>161</dev:defaultValue> </command:parameter> <!-- Parameter: Retry --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Retry</maml:name> <maml:description> <maml:para>Specifies ammount of times SNMP will retry to get values. The default is 1.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: TimeOut --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeOut</maml:name> <maml:description> <maml:para>Determines how long Windows PowerShell waits for this command to complete. The default is 2seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2000</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the SNMP Version used for the connection. The default is 2.</maml:para> <maml:para>Possible values: Ver1, Ver2, Ver3</maml:para> </maml:description> <command:parameterValue required="true">SnmpVersion</command:parameterValue> <dev:type> <maml:name>SnmpSharpNet.SnmpVersion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Ver2</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Ver1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Ver2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Ver3</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IpAddress --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Address,ComputerName,IP,Node"> <maml:name>IpAddress</maml:name> <maml:description> <maml:para>Specifies the address of the device.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Address,ComputerName,IP,Node"> <maml:name>Address</maml:name> <maml:description> <maml:para>Specifies the address of the device.</maml:para> <maml:para>This is an alias of the IpAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Address,ComputerName,IP,Node"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>Specifies the address of the device.</maml:para> <maml:para>This is an alias of the IpAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Address,ComputerName,IP,Node"> <maml:name>IP</maml:name> <maml:description> <maml:para>Specifies the address of the device.</maml:para> <maml:para>This is an alias of the IpAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Address,ComputerName,IP,Node"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the address of the device.</maml:para> <maml:para>This is an alias of the IpAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Oid --> <command:parameter required="true" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Oid</maml:name> <maml:description> <maml:para>Specifies the object identifier (OID). One or more object identifiers (OIDs) may be given as arguments.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Community --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Community</maml:name> <maml:description> <maml:para>Specifies community string for SNMP communication. The default is "public".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>public</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies port used for SNMP communication. The default is "161".</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>161</dev:defaultValue> </command:parameter> <!-- Parameter: Retry --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Retry</maml:name> <maml:description> <maml:para>Specifies ammount of times SNMP will retry to get values. The default is 1.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: TimeOut --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeOut</maml:name> <maml:description> <maml:para>Determines how long Windows PowerShell waits for this command to complete. The default is 2seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2000</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the SNMP Version used for the connection. The default is 2.</maml:para> <maml:para>Possible values: Ver1, Ver2, Ver3</maml:para> </maml:description> <command:parameterValue required="true">SnmpVersion</command:parameterValue> <dev:type> <maml:name>SnmpSharpNet.SnmpVersion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Ver2</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Ver1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Ver2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Ver3</command:parameterValue> </command:parameterValueGroup> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the address of the device.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the object identifier (OID). One or more object identifiers (OIDs) may be given as arguments.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title>Proxx.SNMP</maml:title> <maml:alert> <maml:para>Author: Marco van G. (Proxx) Website: www.Proxx.nl</maml:para> </maml:alert> </maml:alertSet> </command:command> <!-- Cmdlet: Invoke-SnmpWalk --> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <command:details> <command:name>Invoke-SnmpWalk</command:name> <command:verb>Invoke</command:verb> <command:noun>SnmpWalk</command:noun> </command:details> <command:syntax> <!-- Parameter set: __AllParameterSets --> <command:syntaxItem> <maml:name>Invoke-SnmpWalk</maml:name> <!-- Parameter: IpAddress --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Address,ComputerName,IP,Node"> <maml:name>IpAddress</maml:name> <maml:description> <maml:para>Specifies the address of the device.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Oid --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Oid</maml:name> <maml:description> <maml:para>Specifies the object identifier (OID). One or more object identifiers (OIDs) may be given as arguments.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1.3.6.1</dev:defaultValue> </command:parameter> <!-- Parameter: Community --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Community</maml:name> <maml:description> <maml:para>Specifies community string for SNMP communication. The default is "public".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>public</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies port used for SNMP communication. The default is "161".</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>161</dev:defaultValue> </command:parameter> <!-- Parameter: Retry --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Retry</maml:name> <maml:description> <maml:para>Specifies ammount of times SNMP will retry to get values. The default is 1.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: TimeOut --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeOut</maml:name> <maml:description> <maml:para>Determines how long Windows PowerShell waits for this command to complete. The default is 2seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2000</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the SNMP Version used for the connection. The default is 2.</maml:para> <maml:para>Possible values: Ver1, Ver2, Ver3</maml:para> </maml:description> <command:parameterValue required="true">SnmpVersion</command:parameterValue> <dev:type> <maml:name>SnmpSharpNet.SnmpVersion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Ver2</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Ver1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Ver2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Ver3</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>returns the next value even if Current OID is not Root of Parameter OID</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <!-- Parameter: IpAddress --> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Address,ComputerName,IP,Node"> <maml:name>IpAddress</maml:name> <maml:description> <maml:para>Specifies the address of the device.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Address,ComputerName,IP,Node"> <maml:name>Address</maml:name> <maml:description> <maml:para>Specifies the address of the device.</maml:para> <maml:para>This is an alias of the IpAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Address,ComputerName,IP,Node"> <maml:name>ComputerName</maml:name> <maml:description> <maml:para>Specifies the address of the device.</maml:para> <maml:para>This is an alias of the IpAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Address,ComputerName,IP,Node"> <maml:name>IP</maml:name> <maml:description> <maml:para>Specifies the address of the device.</maml:para> <maml:para>This is an alias of the IpAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <command:parameter required="true" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="0" aliases="Address,ComputerName,IP,Node"> <maml:name>Node</maml:name> <maml:description> <maml:para>Specifies the address of the device.</maml:para> <maml:para>This is an alias of the IpAddress parameter.</maml:para> </maml:description> <command:parameterValue required="true">string[]</command:parameterValue> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> </command:parameter> <!-- Parameter: Oid --> <command:parameter required="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2"> <maml:name>Oid</maml:name> <maml:description> <maml:para>Specifies the object identifier (OID). One or more object identifiers (OIDs) may be given as arguments.</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1.3.6.1</dev:defaultValue> </command:parameter> <!-- Parameter: Community --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Community</maml:name> <maml:description> <maml:para>Specifies community string for SNMP communication. The default is "public".</maml:para> </maml:description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>public</dev:defaultValue> </command:parameter> <!-- Parameter: Port --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Port</maml:name> <maml:description> <maml:para>Specifies port used for SNMP communication. The default is "161".</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>161</dev:defaultValue> </command:parameter> <!-- Parameter: Retry --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Retry</maml:name> <maml:description> <maml:para>Specifies ammount of times SNMP will retry to get values. The default is 1.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1</dev:defaultValue> </command:parameter> <!-- Parameter: TimeOut --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>TimeOut</maml:name> <maml:description> <maml:para>Determines how long Windows PowerShell waits for this command to complete. The default is 2seconds.</maml:para> </maml:description> <command:parameterValue required="true">int</command:parameterValue> <dev:type> <maml:name>System.Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>2000</dev:defaultValue> </command:parameter> <!-- Parameter: Version --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Version</maml:name> <maml:description> <maml:para>Specifies the SNMP Version used for the connection. The default is 2.</maml:para> <maml:para>Possible values: Ver1, Ver2, Ver3</maml:para> </maml:description> <command:parameterValue required="true">SnmpVersion</command:parameterValue> <dev:type> <maml:name>SnmpSharpNet.SnmpVersion</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Ver2</dev:defaultValue> <command:parameterValueGroup> <command:parameterValue required="false" variableLength="false">Ver1</command:parameterValue> <command:parameterValue required="false" variableLength="false">Ver2</command:parameterValue> <command:parameterValue required="false" variableLength="false">Ver3</command:parameterValue> </command:parameterValueGroup> </command:parameter> <!-- Parameter: Force --> <command:parameter required="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>returns the next value even if Current OID is not Root of Parameter OID</maml:para> </maml:description> <command:parameterValue required="true">SwitchParameter</command:parameterValue> <dev:type> <maml:name>System.Management.Automation.SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String[]</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the address of the device.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>System.String</maml:name> <maml:uri /> </dev:type> <maml:description> <maml:para>Specifies the object identifier (OID). One or more object identifiers (OIDs) may be given as arguments.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <!-- OutputType: PSObject --> <command:returnValue> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> <maml:uri /> </dev:type> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:title>Proxx.SNMP</maml:title> <maml:alert> <maml:para>Author: Marco van G. (Proxx) Website: www.Proxx.nl</maml:para> </maml:alert> </maml:alertSet> </command:command> </helpItems> |