en-US/MSBITools-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SmoServer</command:name> <command:verb>Get</command:verb> <command:noun>SmoServer</command:noun> <maml:description> <maml:para>Get an instance of an object representing SQL server</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get an instance of an object representing SQL server</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SmoServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Data.SqlClient.SqlConnection</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SqlServer.Management.Smo.Server</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SmoServer</dev:code> <dev:remarks> <maml:para>Get an instance of SQL Server object for the given instance named 'localhost' through pipeline</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SqlServerAgentJob</command:name> <command:verb>Get</command:verb> <command:noun>SqlServerAgentJob</command:noun> <maml:description> <maml:para>Get an instance of SQL Server Agent Job</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get an instance of SQL Sever Agent job. you can give job name and server name as input.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SqlServerAgentJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SmoServer</maml:name> <maml:Description> <maml:para>SQL Server Instance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Server</command:parameterValue> <dev:type> <maml:name>Server</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>JobName</maml:name> <maml:Description> <maml:para>Job Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>JobName</maml:name> <maml:Description> <maml:para>Job Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SmoServer</maml:name> <maml:Description> <maml:para>SQL Server Instance</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Server</command:parameterValue> <dev:type> <maml:name>Server</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Microsoft.SqlServer.Management.Smo.Server</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SqlServer.Management.Smo.Agent.Job</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SmoServer | Get-SqlServerAgentJob -JobName 'myjob'</dev:code> <dev:remarks> <maml:para>Get an Instance of a job with name as 'myjob' from the SQL Server instance 'localhost' through pipeline</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SsisCatalog</command:name> <command:verb>Get</command:verb> <command:noun>SsisCatalog</command:noun> <maml:description> <maml:para>Gets SSIS Catalog</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets SSIS catalog object for default(SSISDB) catalog. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SsisCatalog</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Data.SqlClient.SqlConnection</maml:name> </dev:type> <maml:description> <maml:para>System.String</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SqlServer.Management.IntegrationServices.Catalog</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalog</dev:code> <dev:remarks> <maml:para>Gets SSISDB catalog object for the given SQL Server connection</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SsisCatalogEventMessage</command:name> <command:verb>Get</command:verb> <command:noun>SsisCatalogEventMessage</command:noun> <maml:description> <maml:para>Get messages logged during ssis operation</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get messages logged during ssis operation. You can provide operation id, event message id and sql connection object as input.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SsisCatalogEventMessage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>OperationId</maml:name> <maml:Description> <maml:para>id for operation type from catalog.operations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>EventMessageId</maml:name> <maml:Description> <maml:para>unique message id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>EventMessageId</maml:name> <maml:Description> <maml:para>unique message id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>OperationId</maml:name> <maml:Description> <maml:para>id for operation type from catalog.operations</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> <maml:description> <maml:para>System.Data.SqlClient.SqlConnection</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Data.DataRow</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalogEventMessage -OperationId 10008 -EventMessageId 2</dev:code> <dev:remarks> <maml:para>get instance of message for inputs , 100008 as operation id and event message id as 2 for sql connection object of localhost</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalogEventMessage -OperationId 10008</dev:code> <dev:remarks> <maml:para>get message from catalog.event_messages with input as 2 and sql connection object for localhost.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SsisCatalogExecution</command:name> <command:verb>Get</command:verb> <command:noun>SsisCatalogExecution</command:noun> <maml:description> <maml:para>Get instance of package execution object from SSIS catalog.executions table</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get instance of package execution object from SSIS catalog.executions table. You can provde sql connection object and execution id as input.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SsisCatalogExecution</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>ExecutionId</maml:name> <maml:Description> <maml:para>unique exection id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>ExecutionId</maml:name> <maml:Description> <maml:para>unique exection id</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int64</command:parameterValue> <dev:type> <maml:name>Int64</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> <maml:description> <maml:para>System.Data.SqlClient.SqlConnection</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Data.DataRow</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalogExecution -ExecutionId 10008</dev:code> <dev:remarks> <maml:para>Get instance of package execution object with input as 10008 and server name as localhost.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SsisCatalogFolder</command:name> <command:verb>Get</command:verb> <command:noun>SsisCatalogFolder</command:noun> <maml:description> <maml:para>Gets SSIS catalog folder</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets SSIS catalog folder object for the given catalog. You can provide catalog object or connection object to SQL Server instance as a parameter.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SsisCatalogFolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Catalog</maml:name> <maml:Description> <maml:para>SSIS catalog object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Catalog</command:parameterValue> <dev:type> <maml:name>Catalog</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SsisCatalogFolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Catalog</maml:name> <maml:Description> <maml:para>SSIS catalog object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Catalog</command:parameterValue> <dev:type> <maml:name>Catalog</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Microsoft.SqlServer.Management.IntegrationServices.Catalog</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SqlServer.Management.IntegrationServices.CatalogFolder</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalog | Get-SsisCatalogFolder -FolderName 'myFolder'</dev:code> <dev:remarks> <maml:para>Gets folder object for folder 'myFolder' in catalog given through pipeline</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalogFolder -FolderName 'myFolder'</dev:code> <dev:remarks> <maml:para>Gets folder object for folder 'myFolder' in the default catalog(SSISDB) of SQL Server instance 'localhost'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SsisEnvironment</command:name> <command:verb>Get</command:verb> <command:noun>SsisEnvironment</command:noun> <maml:description> <maml:para>Gets SSIS environment</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets SSIS environment object in the given catalog folder. You can provide folder object or folder name and Sql connection object as parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SsisEnvironment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Folder</maml:name> <maml:Description> <maml:para>SSIS catalog folder object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CatalogFolder</command:parameterValue> <dev:type> <maml:name>CatalogFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SsisEnvironment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Folder</maml:name> <maml:Description> <maml:para>SSIS catalog folder object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CatalogFolder</command:parameterValue> <dev:type> <maml:name>CatalogFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Microsoft.SqlServer.Management.IntegrationServices.CatalogFolder</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SqlServer.Management.IntegrationServices.EnvironmentInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalog | Get-SsisCatalogFolder -FolderName 'myFolder' | Get-SsisEnvironment -EnvName 'myEnvironment'</dev:code> <dev:remarks> <maml:para>Gets environment object for environment 'myEnvironment' in the catalog folder given through pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisEnvironment -EnvName 'myEnvironment' -FolderName 'myFolder'</dev:code> <dev:remarks> <maml:para>Gets environment object for environment 'myEnvironment' in folder 'myFolder' and server instance 'localhost'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SsisPackage</command:name> <command:verb>Get</command:verb> <command:noun>SsisPackage</command:noun> <maml:description> <maml:para>Get an instance of SSIS Package</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get an instance of SSIS Package. you can provide foldername, package name and sql connection object as input.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SsisPackage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>PackageName</maml:name> <maml:Description> <maml:para>SSIS package name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>SSIS project name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="3" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SsisPackage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>PackageName</maml:name> <maml:Description> <maml:para>SSIS package name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Project</maml:name> <maml:Description> <maml:para>SSIS project object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ProjectInfo</command:parameterValue> <dev:type> <maml:name>ProjectInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>PackageName</maml:name> <maml:Description> <maml:para>SSIS package name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Project</maml:name> <maml:Description> <maml:para>SSIS project object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ProjectInfo</command:parameterValue> <dev:type> <maml:name>ProjectInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>SSIS project name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="3" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Microsoft.SqlServer.Management.IntegrationServices.ProjectInfo System.Data.SqlClient.SqlConnection</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SqlServer.Management.IntegrationServices.PackageInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisProject -ProjectName 'myproject' -FolderName 'myprojectfolder'|Get-SsisPackage -PackageName 'mypackage.dtsx'</dev:code> <dev:remarks> <maml:para>Get an instance of SSIS package named 'mypackage.dtsx' under project 'myproject' in sql server instance 'localhost'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalog | Get-SsisCatalogFolder -FolderName 'myFolder' | Get-SsisProject -ProjectName 'myProject'|Get-SsisPackage -PackageName 'mypackage.dtsx'</dev:code> <dev:remarks> <maml:para>Get an instance of SSIS package named 'mypackage.dtsx' under project 'myproject' in sql server instance 'localhost' through the pipeline from folder 'myfolder' in default ssis catalog</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' |Get-SsisPackage -PackageName 'mypackage.dtsx' -FolderName 'myFolder' -ProjectName 'myproject'</dev:code> <dev:remarks> <maml:para>Get an instance of SSIS package 'mypackage.dtsx' throguh pipeline in SSIS Project 'myproject' in SQL server instance 'localhost'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SsisProject</command:name> <command:verb>Get</command:verb> <command:noun>SsisProject</command:noun> <maml:description> <maml:para>Gets SSIS Project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets SSIS project object in the given catalog folder. You can provide folder object or folder name and SQL connection object as parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-SsisProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>SSIS project name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>Folder</maml:name> <maml:Description> <maml:para>SSIS catalog folder object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CatalogFolder</command:parameterValue> <dev:type> <maml:name>CatalogFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SsisProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>SSIS project name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>Sql Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>Folder</maml:name> <maml:Description> <maml:para>SSIS catalog folder object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CatalogFolder</command:parameterValue> <dev:type> <maml:name>CatalogFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>SSIS project name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>Sql Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Microsoft.SqlServer.Management.IntegrationServices.CatalogFolder</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SqlServer.Management.IntegrationServices.ProjectInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalog | Get-SsisCatalogFolder -FolderName 'myFolder' | Get-SsisProject -ProjectName 'myProject'</dev:code> <dev:remarks> <maml:para>Gets project object for project 'myProject' in the catalog folder given through pipeline.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisProject -ProjectName 'myEnvironment' -FolderName 'myFolder'</dev:code> <dev:remarks> <maml:para>Gets project object for project 'myProject' in folder 'myFolder' and server instance 'localhost'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-SqlQuery</command:name> <command:verb>Invoke</command:verb> <command:noun>SqlQuery</command:noun> <maml:description> <maml:para>Execute SQL Query</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Execute SQL Query. You can provide query and sql connection object</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-SqlQuery</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>SqlQuery</maml:name> <maml:Description> <maml:para>SQL Query</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>SqlQuery</maml:name> <maml:Description> <maml:para>SQL Query</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>System.Data.SqlClient.SqlConnection</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Data.DataRow</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Invoke-SqlQuery -SQLQuery 'SELECT * FROM SSISDB.catalog.event_messages'</dev:code> <dev:remarks> <maml:para>Executes any sql query which is passed as a input</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Invoke-SsisPackage</command:name> <command:verb>Invoke</command:verb> <command:noun>SsisPackage</command:noun> <maml:description> <maml:para>Invoke SSIS Package</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Invoke SSIS package based on specified inpus. you can provide project name, folder name, environmanet name and refrences and sql connection object</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Invoke-SsisPackage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>PackageName</maml:name> <maml:Description> <maml:para>SSIS Package name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>EnvFolderName</maml:name> <maml:Description> <maml:para>SSIS environment folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>{{Fill ProjectName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"> <maml:name>ProjectFolderName</maml:name> <maml:Description> <maml:para>SSIS project folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="5" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none"> <maml:name>use32RuntimeOn64</maml:name> <maml:Description> <maml:para>{{Fill use32RuntimeOn64 Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="none"> <maml:name>TimeOutInSeconds</maml:name> <maml:Description> <maml:para>{{Fill TimeOutInSeconds Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Synchronized</maml:name> <maml:Description> <maml:para>{{Fill Synchronized Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-SsisPackage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Package</maml:name> <maml:Description> <maml:para>SSIS Package object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PackageInfo</command:parameterValue> <dev:type> <maml:name>PackageInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>EnvReference</maml:name> <maml:Description> <maml:para>SSIS environment reference</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EnvironmentReference</command:parameterValue> <dev:type> <maml:name>EnvironmentReference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none"> <maml:name>use32RuntimeOn64</maml:name> <maml:Description> <maml:para>{{Fill use32RuntimeOn64 Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="none"> <maml:name>TimeOutInSeconds</maml:name> <maml:Description> <maml:para>{{Fill TimeOutInSeconds Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Synchronized</maml:name> <maml:Description> <maml:para>{{Fill Synchronized Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-SsisPackage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Package</maml:name> <maml:Description> <maml:para>SSIS Package object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PackageInfo</command:parameterValue> <dev:type> <maml:name>PackageInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none"> <maml:name>use32RuntimeOn64</maml:name> <maml:Description> <maml:para>{{Fill use32RuntimeOn64 Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="none"> <maml:name>TimeOutInSeconds</maml:name> <maml:Description> <maml:para>{{Fill TimeOutInSeconds Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Synchronized</maml:name> <maml:Description> <maml:para>{{Fill Synchronized Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Invoke-SsisPackage</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>PackageName</maml:name> <maml:Description> <maml:para>SSIS Package name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>{{Fill ProjectName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"> <maml:name>ProjectFolderName</maml:name> <maml:Description> <maml:para>SSIS project folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="5" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none"> <maml:name>use32RuntimeOn64</maml:name> <maml:Description> <maml:para>{{Fill use32RuntimeOn64 Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="none"> <maml:name>TimeOutInSeconds</maml:name> <maml:Description> <maml:para>{{Fill TimeOutInSeconds Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Synchronized</maml:name> <maml:Description> <maml:para>{{Fill Synchronized Description}}</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>EnvFolderName</maml:name> <maml:Description> <maml:para>SSIS environment folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>EnvReference</maml:name> <maml:Description> <maml:para>SSIS environment reference</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EnvironmentReference</command:parameterValue> <dev:type> <maml:name>EnvironmentReference</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Package</maml:name> <maml:Description> <maml:para>SSIS Package object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PackageInfo</command:parameterValue> <dev:type> <maml:name>PackageInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>PackageName</maml:name> <maml:Description> <maml:para>SSIS Package name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"> <maml:name>ProjectFolderName</maml:name> <maml:Description> <maml:para>SSIS project folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>{{Fill ProjectName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="5" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Synchronized</maml:name> <maml:Description> <maml:para>{{Fill Synchronized Description}}</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="7" aliases="none"> <maml:name>TimeOutInSeconds</maml:name> <maml:Description> <maml:para>{{Fill TimeOutInSeconds Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="6" aliases="none"> <maml:name>use32RuntimeOn64</maml:name> <maml:Description> <maml:para>{{Fill use32RuntimeOn64 Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Microsoft.SqlServer.Management.IntegrationServices.PackageInfo</maml:name> </dev:type> <maml:description> <maml:para>System.String Microsoft.SqlServer.Management.IntegrationServices.EnvironmentReference System.Data.SqlClient.SqlConnection System.Boolean System.Int32</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Int64</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Invoke-SsisPackage -PackageName 'myPackage.dtsx' -EnvName 'myEnvironment' -EnvFolderName 'myEnvironmentFolderName' -ProjectName 'myProjectName' -ProjectFolderName 'myProjectFolderName' -Synchronized</dev:code> <dev:remarks> <maml:para>Call SSIS package from SSIS catalog folder based on the values on names of package, folder and SQL connection along with reference to Environment as input.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Invoke-SsisPackage -PackageName 'myPacakge.dtsx' -ProjectName 'myProject' -FolderName 'myFolder' -SqlServerConnection $sqlConnection -Synchronized</dev:code> <dev:remarks> <maml:para>Call SSIS package from SSIS catalog folder depending on the values on names of package, folder in which package is present along with SQL connection.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisProject -ProjectName 'myProject' -FolderName 'myfolder' | Get-SsisPackage -PackageName 'myPackage' -Project 'myProject' | Invoke-SsisPackage -Synchronized</dev:code> <dev:remarks> <maml:para>Call SSIS package based in references to SSIS Project, package along with SQL server connection as input</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SqlAgentJobEnvReference</command:name> <command:verb>New</command:verb> <command:noun>SqlAgentJobEnvReference</command:noun> <maml:description> <maml:para>Add environment reference to SQL job</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Add reference to environment value created in SSIS catalog folder to a step inside SQL Job. You have to provide enviornment folder name, project name, package name, environment name and SQL Server connection as input.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-SqlAgentJobEnvReference</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>JobName</maml:name> <maml:Description> <maml:para>SQL Job Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS Environment Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>EnvFolderName</maml:name> <maml:Description> <maml:para>SSIS Environment Folder Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>PackageName</maml:name> <maml:Description> <maml:para>SQL Package Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>SSIS Project Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SqlAgentJobEnvReference</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Param File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>EnvFolderName</maml:name> <maml:Description> <maml:para>SSIS Environment Folder Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS Environment Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>JobName</maml:name> <maml:Description> <maml:para>SQL Job Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>PackageName</maml:name> <maml:Description> <maml:para>SQL Package Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Param File Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>SSIS Project Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Data.SqlClient.SqlConnection</maml:name> </dev:type> <maml:description> <maml:para>System.String</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | New-SqlAgentJobEnvReference -JobName 'myJob' -EnvName 'myEnvironment' -EnvFolderName 'myEnvironmentFolder'-ProjectName 'myProject' -PackageName 'Package.dtsx'</dev:code> <dev:remarks> <maml:para>Creates reference of environment 'myEnvironment' in the Job 'myJob' provided through pipeline</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' |New-SqlAgentJobEnvReference -ParamFilePath '.\example1.json'</dev:code> <dev:remarks> <maml:para>Creates reference based on values from example1.json through piepline</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SqlServerAgentJob</command:name> <command:verb>New</command:verb> <command:noun>SqlServerAgentJob</command:noun> <maml:description> <maml:para>Create a SQL agent job in SQL Server</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Create a SQL Agent job in a SQL server Instance. Parameters are added in json file.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-SqlServerAgentJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Data.SqlClient.SqlConnection</maml:name> </dev:type> <maml:description> <maml:para>System.String</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SqlServer.Management.Smo.Agent.Job</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | New-SqlServerAgentJob -ParamFilePath '.\SQLJob.json'</dev:code> <dev:remarks> <maml:para>Create SQL jobs based on values specified in the 'SQLJob.json' through the pipeline for sql server instance 'localhost'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SqlServerConnection</command:name> <command:verb>New</command:verb> <command:noun>SqlServerConnection</command:noun> <maml:description> <maml:para>Creates a new connection object for the given SQL server instance.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a new SQL Server connection object. You can provide a target server instance name or connection string as input.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-SqlServerConnection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ConnectionString</maml:name> <maml:Description> <maml:para>SQL Server connection string</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SqlServerConnection</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ServerName</maml:name> <maml:Description> <maml:para>SQL Server instance name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ConnectionString</maml:name> <maml:Description> <maml:para>SQL Server connection string</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ServerName</maml:name> <maml:Description> <maml:para>SQL Server instance name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Data.SqlClient.SqlConnection</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost'</dev:code> <dev:remarks> <maml:para>Creates a new SQL Server connection object for the 'localhost' using server instance name</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ConnectionString "Data Source=localhost;Initial Catalog=master;Integrated Security=SSPI;"</dev:code> <dev:remarks> <maml:para>Creates a new SQL Server connection object for the 'localhost' using connection string</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SsisCatalogFolder</command:name> <command:verb>New</command:verb> <command:noun>SsisCatalogFolder</command:noun> <maml:description> <maml:para>Creates SSIS catalog folder</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates SSIS catalog folder in the given catalog. You can provide catalog object or SQL Server connection as input</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-SsisCatalogFolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Catalog</maml:name> <maml:Description> <maml:para>SSIS catalog object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Catalog</command:parameterValue> <dev:type> <maml:name>Catalog</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SsisCatalogFolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SsisCatalogFolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Catalog</maml:name> <maml:Description> <maml:para>SSIS catalog object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Catalog</command:parameterValue> <dev:type> <maml:name>Catalog</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Microsoft.SqlServer.Management.IntegrationServices.Catalog</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SqlServer.Management.IntegrationServices.CatalogFolder</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalog | New-SsisCatalogFolder -FolderName 'myFolder'</dev:code> <dev:remarks> <maml:para>Creates catalog folder 'myFolder' in the catalog provided through pipeline</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | New-SsisCatalogFolder -FolderName 'myFolder'</dev:code> <dev:remarks> <maml:para>Creates catalog folder 'myFolder' in the default catalog(SSISDB) of SQL Server instance 'localhost'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | New-SsisCatalogFolder -ParamFilePath '.\example1.json'</dev:code> <dev:remarks> <maml:para>Creates catalog folder(s) specified in the parameter file 'example1.json'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SsisEnvironment</command:name> <command:verb>New</command:verb> <command:noun>SsisEnvironment</command:noun> <maml:description> <maml:para>Creates SSIS environment</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates SSIS environment in the given catalog folder. You can provide folder object or folder name and SQL Server connection as input</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-SsisEnvironment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SsisEnvironment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Folder</maml:name> <maml:Description> <maml:para>SSIS catalog folder object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CatalogFolder</command:parameterValue> <dev:type> <maml:name>CatalogFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SsisEnvironment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Folder</maml:name> <maml:Description> <maml:para>SSIS catalog folder object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CatalogFolder</command:parameterValue> <dev:type> <maml:name>CatalogFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Microsoft.SqlServer.Management.IntegrationServices.CatalogFolder</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SqlServer.Management.IntegrationServices.EnvironmentInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalog | Get-SsisCatalogFolder -FolderName 'myFolder' | New-SsisEnvironment -EnvName 'myEnvironment'</dev:code> <dev:remarks> <maml:para>Creates environment 'myEnvironment' in catalog folder provided through pipeline</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | New-SsisEnvironment -EnvName 'myEnvironment' -FolderName 'myFolder'</dev:code> <dev:remarks> <maml:para>Creates environment 'myEnvironment' in catalog folder 'myFolder' in SQL Server instance 'localhost'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | New-SsisEnvironment -ParamFilePath '.\example1.json'</dev:code> <dev:remarks> <maml:para>Creates environment(s) specified in parameter file 'example1.json'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SsisEnvironmentVariable</command:name> <command:verb>New</command:verb> <command:noun>SsisEnvironmentVariable</command:noun> <maml:description> <maml:para>Creates SSIS environment variable</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Created SSIS environment variable in the given environment. You can provide environment object or folder name, environment name and SQL Server connection as input</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-SsisEnvironmentVariable</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>VarName</maml:name> <maml:Description> <maml:para>SSIS environment variable name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>VarType</maml:name> <maml:Description> <maml:para>SSIS environment variable type</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Empty</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DBNull</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Boolean</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Char</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SByte</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Byte</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Int16</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UInt16</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Int32</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UInt32</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Int64</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UInt64</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Single</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Double</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Decimal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DateTime</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">String</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">TypeCode</command:parameterValue> <dev:type> <maml:name>TypeCode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>VarValue</maml:name> <maml:Description> <maml:para>SSIS environment variable value</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>VarDescription</maml:name> <maml:Description> <maml:para>SSIS environment variable description</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>VarSensitive</maml:name> <maml:Description> <maml:para>SSIS environment variable sensitive flag</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SsisEnvironmentVariable</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>VarName</maml:name> <maml:Description> <maml:para>SSIS environment variable name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>VarType</maml:name> <maml:Description> <maml:para>SSIS environment variable type</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">Empty</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Object</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DBNull</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Boolean</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Char</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">SByte</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Byte</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Int16</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UInt16</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Int32</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UInt32</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Int64</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UInt64</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Single</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Double</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Decimal</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">DateTime</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">String</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">TypeCode</command:parameterValue> <dev:type> <maml:name>TypeCode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>VarValue</maml:name> <maml:Description> <maml:para>SSIS environment variable value</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="3" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>SSIS environment object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EnvironmentInfo</command:parameterValue> <dev:type> <maml:name>EnvironmentInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>VarDescription</maml:name> <maml:Description> <maml:para>SSIS environment variable description</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>VarSensitive</maml:name> <maml:Description> <maml:para>SSIS environment variable sensitive flag</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SsisEnvironmentVariable</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="3" aliases="none"> <maml:name>Environment</maml:name> <maml:Description> <maml:para>SSIS environment object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">EnvironmentInfo</command:parameterValue> <dev:type> <maml:name>EnvironmentInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>VarDescription</maml:name> <maml:Description> <maml:para>SSIS environment variable description</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>VarName</maml:name> <maml:Description> <maml:para>SSIS environment variable name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>VarSensitive</maml:name> <maml:Description> <maml:para>SSIS environment variable sensitive flag</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>VarType</maml:name> <maml:Description> <maml:para>SSIS environment variable type</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">TypeCode</command:parameterValue> <dev:type> <maml:name>TypeCode</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>VarValue</maml:name> <maml:Description> <maml:para>SSIS environment variable value</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>System.TypeCode System.Object Microsoft.SqlServer.Management.IntegrationServices.EnvironmentInfo System.Boolean</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SqlServer.Management.IntegrationServices.EnvironmentVariable</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalog | Get-SsisCatalogFolder -FolderName 'myFolder' | Get-SsisEnvironment -EnvName 'myEnvironment' | New-SsisEnvironmentVariable -VarName 'myVar' -VarType String -VarValue 'my value' -VarSensitive $false -VarDescription 'my value description'</dev:code> <dev:remarks> <maml:para>Creates variable 'myVar' in the environment provided through pipeline</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> $SqlServerConn = New-SqlServerConnection -ServerName 'localhost' PS C:\> New-SsisEnvironmentVariable -VarName 'myVar' -VarType String -VarValue 'my value' -VarSensitive $false -VarDescription 'my value description' ` >> -EnvName 'myEnvironment' -FolderName 'myFolder' -SqlServerConnection $SqlServerConn</dev:code> <dev:remarks> <maml:para>Creates variable 'myVar' in environment 'myEnvironment' in folder 'myFolder' in SQL Server instance 'localhost'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | New-SsisEnvironment -ParamFilePath '.\example1.json'</dev:code> <dev:remarks> <maml:para>Creates variable(s) specified in parameter file 'example1.json'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SsisProject</command:name> <command:verb>New</command:verb> <command:noun>SsisProject</command:noun> <maml:description> <maml:para>Creates SSIS project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates SSIS project in the given folder from the ISPAC file. You can provide folder object or folder name and SQL Server connection</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-SsisProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>SSIS project name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ProjectFilePath</maml:name> <maml:Description> <maml:para>ISPAC file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="3" aliases="none"> <maml:name>Folder</maml:name> <maml:Description> <maml:para>SSIS catalog folder object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CatalogFolder</command:parameterValue> <dev:type> <maml:name>CatalogFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SsisProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>SSIS project name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ProjectFilePath</maml:name> <maml:Description> <maml:para>ISPAC file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SsisProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectFilePathPrefix</maml:name> <maml:Description> <maml:para>Folder path containing Project</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="3" aliases="none"> <maml:name>Folder</maml:name> <maml:Description> <maml:para>SSIS catalog folder object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CatalogFolder</command:parameterValue> <dev:type> <maml:name>CatalogFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ProjectFilePath</maml:name> <maml:Description> <maml:para>ISPAC file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>SSIS project name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"> <maml:name>ProjectFilePathPrefix</maml:name> <maml:Description> <maml:para>Folder path containing Project</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Microsoft.SqlServer.Management.IntegrationServices.CatalogFolder</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SqlServer.Management.IntegrationServices.ProjectInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalog | Get-SsisCatalogFolder -FolderName 'myFolder' | New-SsisProject -ProjectName 'myProject'</dev:code> <dev:remarks> <maml:para>Creates project 'myProject' in catalog folder provided through pipeline</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | New-SsisProject -ProjectName 'myProject' -FolderName 'myFolder'</dev:code> <dev:remarks> <maml:para>Creates project 'myProject' in catalog folder 'myFolder' in SQL Server instance 'localhost'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | New-SsisProject -ParamFilePath '.\example1.json'</dev:code> <dev:remarks> <maml:para>Creates projects(s) specified in parameter file 'example1.json'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SsisProjectEnvReference</command:name> <command:verb>New</command:verb> <command:noun>SsisProjectEnvReference</command:noun> <maml:description> <maml:para>Creates environment reference to a SSIS Project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates environment reference to the given SSIS project. You can provide the project object or folder name, project name and SQL Server connection as input</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-SsisProjectEnvReference</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>EnvFolderName</maml:name> <maml:Description> <maml:para>SSIS environment folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>SSIS project name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SsisProjectEnvReference</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>EnvFolderName</maml:name> <maml:Description> <maml:para>SSIS environment folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>Project</maml:name> <maml:Description> <maml:para>SSIS project object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ProjectInfo</command:parameterValue> <dev:type> <maml:name>ProjectInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SsisProjectEnvReference</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>EnvFolderName</maml:name> <maml:Description> <maml:para>SSIS environment folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>Project</maml:name> <maml:Description> <maml:para>SSIS project object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ProjectInfo</command:parameterValue> <dev:type> <maml:name>ProjectInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>SSIS project name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Microsoft.SqlServer.Management.IntegrationServices.ProjectInfo System.Data.SqlClient.SqlConnection</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SqlServer.Management.IntegrationServices.EnvironmentReference</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalog | Get-SsisCatalogFolder -FolderName 'myFolder' | Get-SsisProject -ProjectName 'myProject' | New-SsisProjectEnvReference -EnvName 'myEnvironment' -EnvFolderName 'myFolder'</dev:code> <dev:remarks> <maml:para>Creates reference of environment 'myEnvironment' in the project provided through pipeline</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | New-SsisProjectEnvReference -EnvName 'myEnvironment' -EnvFolderName 'myFolder' -ProjectName 'myProject'</dev:code> <dev:remarks> <maml:para>Creates reference of environment 'myEnvironment' to project 'myProject' in folder 'myFolder' in SQL Server instance 'localhost'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | New-SsisProjectEnvReference -ParamFilePath '.\example1.json'</dev:code> <dev:remarks> <maml:para>Creates reference based on values from example1.json through piepline</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SqlServerAgentJob</command:name> <command:verb>Remove</command:verb> <command:noun>SqlServerAgentJob</command:noun> <maml:description> <maml:para>Remove a SQL Job from SQL server instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Remove SQL Agent job from SQL server. You can provide job name and sql connection as input.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-SqlServerAgentJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>JobName</maml:name> <maml:Description> <maml:para>Job Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SqlServerAgentJob</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>JobName</maml:name> <maml:Description> <maml:para>Job Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Data.SqlClient.SqlConnection</maml:name> </dev:type> <maml:description> <maml:para>System.String</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\>New-SqlServerConnection -ServerName 'localhost' | Remove-SqlServerAgentJob -ParamFilePath '.\SQLJob.json'</dev:code> <dev:remarks> <maml:para>Remove SQL jobs based on values specified in the ParamFilePath through the pipeline for sql server instance 'localhost'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Remove-SqlServerAgentJob -JobName 'Project x'</dev:code> <dev:remarks> <maml:para>Remove SQL jobs with the name specified for JobName parameter through the pipeline for sql server instance 'localhost'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SsisCatalogFolder</command:name> <command:verb>Remove</command:verb> <command:noun>SsisCatalogFolder</command:noun> <maml:description> <maml:para>Delete SSIS Catalog Folder</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates SSIS catalog folder in the given catalog. You can provide catalog object or SQL Server connection as input</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-SsisCatalogFolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Catalog</maml:name> <maml:Description> <maml:para>SSIS catalog object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Catalog</command:parameterValue> <dev:type> <maml:name>Catalog</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SsisCatalogFolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SsisCatalogFolder</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Catalog</maml:name> <maml:Description> <maml:para>SSIS catalog object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Catalog</command:parameterValue> <dev:type> <maml:name>Catalog</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Microsoft.SqlServer.Management.IntegrationServices.Catalog System.Data.SqlClient.SqlConnection</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalog | Remove-SsisCatalogFolder -FolderName 'myFolder'</dev:code> <dev:remarks> <maml:para>Deletes catalog folder 'myFolder' in the catalog provided through pipeline</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Remove-SsisCatalogFolder -FolderName 'myFolder'</dev:code> <dev:remarks> <maml:para>Deletes catalog folder 'myFolder' in the default catalog(SSISDB) of SQL Server instance 'localhost'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Remove-SsisCatalogFolder -ParamFilePath '.\example1.json'</dev:code> <dev:remarks> <maml:para>Deletes catalog folder(s) specified in the parameter file 'example1.json'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SsisEnvironment</command:name> <command:verb>Remove</command:verb> <command:noun>SsisEnvironment</command:noun> <maml:description> <maml:para>Delete SSIS Environment</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete SSIS environment in the given catalog folder. You can provide folder object or folder name and SQL Server connection as input</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-SsisEnvironment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SsisEnvironment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Folder</maml:name> <maml:Description> <maml:para>SSIS catalog folder object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CatalogFolder</command:parameterValue> <dev:type> <maml:name>CatalogFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SsisEnvironment</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>EnvName</maml:name> <maml:Description> <maml:para>SSIS environment name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>Folder</maml:name> <maml:Description> <maml:para>SSIS catalog folder object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CatalogFolder</command:parameterValue> <dev:type> <maml:name>CatalogFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Microsoft.SqlServer.Management.IntegrationServices.CatalogFolder System.Data.SqlClient.SqlConnection</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Get-SsisCatalog | Get-SsisCatalogFolder -FolderName 'myFolder' | Remove-SsisEnvironment -EnvName 'myEnvironment'</dev:code> <dev:remarks> <maml:para>Delete environment 'myEnvironment' in catalog folder provided through pipeline</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Remove-SsisEnvironment -EnvName 'myEnvironment' -FolderName 'myFolder'</dev:code> <dev:remarks> <maml:para>Delete environment 'myEnvironment' in catalog folder 'myFolder' in SQL Server instance 'localhost'</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Remove-SsisEnvironment -ParamFilePath '.\example1.json'</dev:code> <dev:remarks> <maml:para>Deletes environment(s) specified in parameter file 'example1.json'</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SsisProject</command:name> <command:verb>Remove</command:verb> <command:noun>SsisProject</command:noun> <maml:description> <maml:para>Remove SSIS Job from SQL server Instance</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Delete a SSIS project from SQL Server instance based on specified parameters.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-SsisProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>SSIS Project Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ProjectFilePath</maml:name> <maml:Description> <maml:para>Folder path containing Project</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="3" aliases="none"> <maml:name>Folder</maml:name> <maml:Description> <maml:para>SSIS catalog folder object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CatalogFolder</command:parameterValue> <dev:type> <maml:name>CatalogFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SsisProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>SSIS Project Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ProjectFilePath</maml:name> <maml:Description> <maml:para>Folder path containing Project</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-SsisProject</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="3" aliases="none"> <maml:name>Folder</maml:name> <maml:Description> <maml:para>SSIS catalog folder object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CatalogFolder</command:parameterValue> <dev:type> <maml:name>CatalogFolder</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS catalog folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ProjectFilePath</maml:name> <maml:Description> <maml:para>Folder path containing Project</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>SSIS Project Name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="2" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Microsoft.SqlServer.Management.IntegrationServices.CatalogFolder System.Data.SqlClient.SqlConnection</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Boolean</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <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" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-SsisProjectParameterValue</command:name> <command:verb>Set</command:verb> <command:noun>SsisProjectParameterValue</command:noun> <maml:description> <maml:para>Set parameters for SSIS Project</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Set parameters in SSIS project. You can use paramenter name, value and project info as input along with sql connection object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-SsisProjectParameterValue</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamName</maml:name> <maml:Description> <maml:para>{{Fill ParamName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ParamValue</maml:name> <maml:Description> <maml:para>{{Fill ParamValue Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>ParamValueType</maml:name> <maml:Description> <maml:para>{{Fill ParamValueType Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS Folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>{{Fill ProjectName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SsisProjectParameterValue</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-SsisProjectParameterValue</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamName</maml:name> <maml:Description> <maml:para>{{Fill ParamName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ParamValue</maml:name> <maml:Description> <maml:para>{{Fill ParamValue Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>ParamValueType</maml:name> <maml:Description> <maml:para>{{Fill ParamValueType Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="3" aliases="none"> <maml:name>Project</maml:name> <maml:Description> <maml:para>{{Fill Project Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ProjectInfo</command:parameterValue> <dev:type> <maml:name>ProjectInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="3" aliases="none"> <maml:name>FolderName</maml:name> <maml:Description> <maml:para>SSIS Folder name</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamFilePath</maml:name> <maml:Description> <maml:para>Parameter file Path</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="none"> <maml:name>ParamName</maml:name> <maml:Description> <maml:para>{{Fill ParamName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="1" aliases="none"> <maml:name>ParamValue</maml:name> <maml:Description> <maml:para>{{Fill ParamValue Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="2" aliases="none"> <maml:name>ParamValueType</maml:name> <maml:Description> <maml:para>{{Fill ParamValueType Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="3" aliases="none"> <maml:name>Project</maml:name> <maml:Description> <maml:para>{{Fill Project Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">ProjectInfo</command:parameterValue> <dev:type> <maml:name>ProjectInfo</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="4" aliases="none"> <maml:name>ProjectName</maml:name> <maml:Description> <maml:para>{{Fill ProjectName Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="1" aliases="none"> <maml:name>SqlServerConnection</maml:name> <maml:Description> <maml:para>SQL Server connection object</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SqlConnection</command:parameterValue> <dev:type> <maml:name>SqlConnection</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.String</maml:name> </dev:type> <maml:description> <maml:para>Microsoft.SqlServer.Management.IntegrationServices.ProjectInfo System.Data.SqlClient.SqlConnection</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Microsoft.SqlServer.Management.IntegrationServices.ParameterInfo</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS C:\> {{ Add example code here }}</dev:code> <dev:remarks> <maml:para>{{ Add example description here }}</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS C:\> New-SqlServerConnection -ServerName 'localhost' | Set-SsisProjectParameterValue -ParamFilePath '.\example1.json'</dev:code> <dev:remarks> <maml:para>Create parameter based on example1.json file through the pipeline</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |