universal-docs/cmdlets/Remove-PSUScript.txt at v5 · ironmansoftware/universal-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

NAME
    Remove-PSUScript

SYNOPSIS
    Removes a script.


SYNTAX
    Remove-PSUScript [-Id] <Int64> [-AppToken <String>] [-ComputerName <String>] [-Integrated] [-UseDefaultCredentials] [-Credential <PSCredential>] [-TrustCertificate] [<CommonParameters>]

    Remove-PSUScript [-AppToken <String>] [-ComputerName <String>] [-Integrated] -Script <Script> [-UseDefaultCredentials] [-Credential <PSCredential>] [-TrustCertificate] [<CommonParameters>]


DESCRIPTION
    Removes a script. This also deletes the script from the PSU internal git repo as well as an optionally configured remote.


PARAMETERS
    -AppToken <String>
        {{ Fill AppToken Description }}

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Aliases                      none
        Accept wildcard characters?  false

    -ComputerName <String>
        {{ Fill ComputerName Description }}

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Aliases                      Uri
        Accept wildcard characters?  false

    -Integrated [<SwitchParameter>]
        {{ Fill Integrated Description }}

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       False
        Aliases                      none
        Accept wildcard characters?  false

    -Id <Int64>
        The Id of the script to remove.

        Required?                    true
        Position?                    0
        Default value                None
        Accept pipeline input?       False
        Aliases                      none
        Accept wildcard characters?  false

    -Script <Script>
        {{ Fill Script Description }}

        Required?                    true
        Position?                    named
        Default value                None
        Accept pipeline input?       True (ByValue)
        Aliases                      none
        Accept wildcard characters?  false

    -UseDefaultCredentials [<SwitchParameter>]
        {{ Fill UseDefaultCredentials Description }}

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       False
        Aliases                      none
        Accept wildcard characters?  false

    -Credential <PSCredential>
        Credentials to login to the PowerShell Universal Management API.

        Required?                    false
        Position?                    named
        Default value                None
        Accept pipeline input?       False
        Aliases                      none
        Accept wildcard characters?  false

    -TrustCertificate [<SwitchParameter>]
        Whether the cmdlet should ignore certificate issues.

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       False
        Aliases                      none
        Accept wildcard characters?  false

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS
    UniversalAutomation.Script


OUTPUTS
    System.Object


NOTES


    -------------------------- Example 1 --------------------------

    PS C:\> $Script = Get-UAScript -Name 'Script1.ps1'
    PS C:\> Remove-UAScript -Script $Script

    Removes 'Script1.ps1'

RELATED LINKS