en-US/PSPortainer-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>Connect-Portainer</command:name> <command:verb>Connect</command:verb> <command:noun>Portainer</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>Connect to a Portainer instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Connect-Portainer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BaseURL</maml:name> <maml:description> <maml:para>Defines the base URL to the portainer instance</maml:para> <maml:para>-BaseURL 'https://portainer.contoso.com'</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="False" position="named" aliases="none"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Connects to portainer using a access token. This AccessToken can be generated from the Portainer Web GUI.</maml:para> <maml:para>-AccessToken 'ptr_ABoR54bB1NUc4aNY0F2PhppP1tVDu2Husr3vEbPUsw5'</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="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>This parameter will cause the function to return a PortainerSession object that can be stored in a variable and referensed with the -Session parameter on most cmdlets.</maml:para> <maml:para>-PassThru</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>Connect-Portainer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BaseURL</maml:name> <maml:description> <maml:para>Defines the base URL to the portainer instance</maml:para> <maml:para>-BaseURL 'https://portainer.contoso.com'</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="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Connect to portainer using username and password. Parameter accepts a PSCredentials object</maml:para> <maml:para>-Credential (Get-Credential)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</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>PassThru</maml:name> <maml:description> <maml:para>This parameter will cause the function to return a PortainerSession object that can be stored in a variable and referensed with the -Session parameter on most cmdlets.</maml:para> <maml:para>-PassThru</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="False" position="named" aliases="none"> <maml:name>BaseURL</maml:name> <maml:description> <maml:para>Defines the base URL to the portainer instance</maml:para> <maml:para>-BaseURL 'https://portainer.contoso.com'</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="False" position="named" aliases="none"> <maml:name>AccessToken</maml:name> <maml:description> <maml:para>Connects to portainer using a access token. This AccessToken can be generated from the Portainer Web GUI.</maml:para> <maml:para>-AccessToken 'ptr_ABoR54bB1NUc4aNY0F2PhppP1tVDu2Husr3vEbPUsw5'</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="False" position="named" aliases="none"> <maml:name>Credential</maml:name> <maml:description> <maml:para>Connect to portainer using username and password. Parameter accepts a PSCredentials object</maml:para> <maml:para>-Credential (Get-Credential)</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type> <maml:name>PSCredential</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>PassThru</maml:name> <maml:description> <maml:para>This parameter will cause the function to return a PortainerSession object that can be stored in a variable and referensed with the -Session parameter on most cmdlets.</maml:para> <maml:para>-PassThru</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:parameters> <command:inputTypes /> <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>Connect-Portainer -BaseURL 'https://portainer.contoso.com' -AccessToken 'ptr_ABoR54bB1NUc4aNY0F2PhppP1tVDu2Husr3vEbPUsw5='</dev:code> <dev:remarks> <maml:para>Connect using access token</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Connect-Portainer -BaseURL 'https://portainer.contoso.com' -Credentials (Get-Credential)</dev:code> <dev:remarks> <maml:para>Connect using username and password</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>Disconnect-Portainer</command:name> <command:verb>Disconnect</command:verb> <command:noun>Portainer</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>Disconnect and cleanup session configuration</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Disconnect-Portainer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Defines a PortainerSession object that will be disconnected and cleaned up.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Defines a PortainerSession object that will be disconnected and cleaned up.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>Disconnect-Portainer</dev:code> <dev:remarks> <maml:para>Disconnect from the default portainer session</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>Disconnect-Portainer -Session $Session</dev:code> <dev:remarks> <maml:para>Disconnect the specified session</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-PContainer</command:name> <command:verb>Get</command:verb> <command:noun>PContainer</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retreives docker containers</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PContainer</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:description> <maml:para>Defines the portainer endpoint to use when retreiving containers. If not specified the portainer sessions default docker endpoint value is used.</maml:para> <maml:para>Use Get-PSession to see what endpoint is selected</maml:para> <maml:para>Use Select-PEndpoint to change the default docker endpoint in the portainer session.</maml:para> <maml:para>-Endpoint 'local'</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 (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Defines the id of the container to retreive.</maml:para> <maml:para>-Id '<Id>'</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.</maml:para> <maml:para>-Session $Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Endpoint</maml:name> <maml:description> <maml:para>Defines the portainer endpoint to use when retreiving containers. If not specified the portainer sessions default docker endpoint value is used.</maml:para> <maml:para>Use Get-PSession to see what endpoint is selected</maml:para> <maml:para>Use Select-PEndpoint to change the default docker endpoint in the portainer session.</maml:para> <maml:para>-Endpoint 'local'</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 (ByValue)" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Defines the id of the container to retreive.</maml:para> <maml:para>-Id '<Id>'</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="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.</maml:para> <maml:para>-Session $Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>Get-PContainer</dev:code> <dev:remarks> <maml:para>Retreives all containers from the endpoint configured on the portainer session default docker endpoint setting.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title> <dev:code>'</dev:code> <dev:remarks> <maml:para>Retreives a single container object with the specified Id</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title> <dev:code>Get-PContainer -Endpoint 'prod'</dev:code> <dev:remarks> <maml:para>Retreives all containers on the prod endpoint</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title> <dev:code>Get-PContainer -Session $Session</dev:code> <dev:remarks> <maml:para>Retreives all containers on the portainer instance defined</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-PContainerProcess</command:name> <command:verb>Get</command:verb> <command:noun>PContainerProcess</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get processes running inside the container</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PContainerProcess</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Endpoint</maml:name> <maml:description> <maml:para>Defines the portainer endpoint to use when retreiving containers. If not specified the portainer sessions default docker endpoint value is used.</maml:para> <maml:para>Use Get-PSession to see what endpoint is selected</maml:para> <maml:para>Use Select-PEndpoint to change the default docker endpoint in the portainer session.</maml:para> <maml:para>-Endpoint 'local'</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 (ByValue)" position="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Defines the id of the container to retreive.</maml:para> <maml:para>-Id '<Id>'</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="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.</maml:para> <maml:para>-Session $Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Endpoint</maml:name> <maml:description> <maml:para>Defines the portainer endpoint to use when retreiving containers. If not specified the portainer sessions default docker endpoint value is used.</maml:para> <maml:para>Use Get-PSession to see what endpoint is selected</maml:para> <maml:para>Use Select-PEndpoint to change the default docker endpoint in the portainer session.</maml:para> <maml:para>-Endpoint 'local'</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 (ByValue)" position="2" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Defines the id of the container to retreive.</maml:para> <maml:para>-Id '<Id>'</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="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.</maml:para> <maml:para>-Session $Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>' | Get-PContainerProcess</dev:code> <dev:remarks> <maml:para>Retreives the running processes in the specified container</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-PEndpoint</command:name> <command:verb>Get</command:verb> <command:noun>PEndpoint</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retreives endpoints</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Defines a searchstring to use for filtering endpoints</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="False" position="named" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.</maml:para> <maml:para>-Session $Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-PEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Defines the Id of the endpoint to retreive.</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>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.</maml:para> <maml:para>-Session $Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>SearchString</maml:name> <maml:description> <maml:para>Defines a searchstring to use for filtering endpoints</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="False" position="named" aliases="none"> <maml:name>Id</maml:name> <maml:description> <maml:para>Defines the Id of the endpoint to retreive.</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>0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.</maml:para> <maml:para>-Session $Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>Get-PEndpoint -SearchString 'local'</dev:code> <dev:remarks> <maml:para>Retreives all endpoints containing the word local</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-PortainerContainer</command:name> <command:verb>Get</command:verb> <command:noun>PortainerContainer</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retreives containers</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PortainerContainer</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <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>Get-PortainerContainer Description of example</dev:code> <dev:remarks> <maml:para></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-PortainerSession</command:name> <command:verb>Get</command:verb> <command:noun>PortainerSession</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PortainerSession</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <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>Get-PortainerSession Description of example</dev:code> <dev:remarks> <maml:para></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-PortainerSettingsPublic</command:name> <command:verb>Get</command:verb> <command:noun>PortainerSettingsPublic</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retreives Portainer Public Settings</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PortainerSettingsPublic</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <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>Get-PortainerSettingsPublic</dev:code> <dev:remarks> <maml:para>Retreives Portainer Public Settings</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-PortainerStatus</command:name> <command:verb>Get</command:verb> <command:noun>PortainerStatus</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get public status for portainer instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PortainerStatus</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes /> <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>Get-PortainerStatus</dev:code> <dev:remarks> <maml:para>Get public status for portainer instance</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-PSession</command:name> <command:verb>Get</command:verb> <command:noun>PSession</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>Displays the Portainer Session object.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSession</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.</maml:para> <maml:para>-Session $Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.</maml:para> <maml:para>-Session $Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>Get-PSession</dev:code> <dev:remarks> <maml:para>Returns the PortainerSession, if none is specified, it tries to retreive the default</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-PSettingsPublic</command:name> <command:verb>Get</command:verb> <command:noun>PSettingsPublic</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>Retreives Portainer Public Settings</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PSettingsPublic</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.</maml:para> <maml:para>-Session $Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.</maml:para> <maml:para>-Session $Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>Get-PSettingsPublic</dev:code> <dev:remarks> <maml:para>Retreives Portainer Public Settings</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-PStatus</command:name> <command:verb>Get</command:verb> <command:noun>PStatus</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>Get public status for portainer instance</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-PStatus</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.</maml:para> <maml:para>-Session $Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.</maml:para> <maml:para>-Session $Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>Get-PStatus</dev:code> <dev:remarks> <maml:para>Get public status for portainer instance</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>Select-PEndpoint</command:name> <command:verb>Select</command:verb> <command:noun>PEndpoint</command:noun> <maml:description> <maml:para></maml:para> </maml:description> </command:details> <maml:description> <maml:para>Configures the default endpoint to use</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Select-PEndpoint</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Endpoint</maml:name> <maml:description> <maml:para>Defines the endpoint name to select</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="False" position="2" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.</maml:para> <maml:para>-Session $Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Endpoint</maml:name> <maml:description> <maml:para>Defines the endpoint name to select</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="False" position="2" aliases="none"> <maml:name>Session</maml:name> <maml:description> <maml:para>Optionally define a portainer session object to use. This is useful when you are connected to more than one portainer instance.</maml:para> <maml:para>-Session $Session</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PortainerSession</command:parameterValue> <dev:type> <maml:name>PortainerSession</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <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>Select-PEndpoint -Endpoint 'prod'</dev:code> <dev:remarks> <maml:para>Set the default endpoint to use</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |