File size: 8,734 Bytes
8c763fb | 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 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
#region Using directives
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Management.Automation;
#endregion
/******************************************************************************
* warning 28750: Banned usage of lstrlen and its variants: lstrlenW is a
* banned API for improved error handling purposes.
*****************************************************************************/
namespace Microsoft.Management.Infrastructure.CimCmdlets
{
/// <summary>
/// This Cmdlet allows the to remove, or terminate, one or more CimSession(s).
/// </summary>
[Alias("rcms")]
[Cmdlet(VerbsCommon.Remove, "CimSession",
SupportsShouldProcess = true,
DefaultParameterSetName = CimSessionSet,
HelpUri = "https://go.microsoft.com/fwlink/?LinkId=227968")]
public sealed class RemoveCimSessionCommand : CimBaseCommand
{
#region constructor
/// <summary>
/// Initializes a new instance of the <see cref="RemoveCimSessionCommand"/> class.
/// </summary>
public RemoveCimSessionCommand()
: base(parameters, parameterSets)
{
}
#endregion
#region parameters
/// <summary>
/// The following is the definition of the input parameter "CimSession".
/// Specifies one or more CimSession object to be removed from the local PS
/// session/runspace.
/// </summary>
[Parameter(
Mandatory = true,
Position = 0,
ValueFromPipeline = true,
ValueFromPipelineByPropertyName = true,
ParameterSetName = CimSessionSet)]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public CimSession[] CimSession
{
get
{
return cimsession;
}
set
{
cimsession = value;
base.SetParameter(value, nameCimSession);
}
}
private CimSession[] cimsession;
/// <summary>
/// <para>The following is the definition of the input parameter "ComputerName".
/// Specified one or more computer names for which all CimSession(s)
/// (connections) should be removed (terminated).</para>
/// <para>This is the only optional parameter. If no value for this parameter is
/// provided, all CimSession(s) are terminated.</para>
/// </summary>
[Alias(AliasCN, AliasServerName)]
[Parameter(
Mandatory = true,
Position = 0,
ValueFromPipelineByPropertyName = true,
ParameterSetName = ComputerNameSet)]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] ComputerName
{
get
{
return computername;
}
set
{
computername = value;
base.SetParameter(value, nameComputerName);
}
}
private string[] computername;
/// <summary>
/// The following is the definition of the input parameter "Id".
/// Specifies the friendly Id(s) of the CimSession(s) that should be removed
/// (terminated).
/// </summary>
[Parameter(Mandatory = true,
Position = 0,
ValueFromPipelineByPropertyName = true,
ParameterSetName = SessionIdSet)]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public uint[] Id
{
get
{
return id;
}
set
{
id = value;
base.SetParameter(value, nameId);
}
}
private uint[] id;
/// <summary>
/// The following is the definition of the input parameter "InstanceId".
/// Specifies one or more automatically generated InstanceId(s) (GUIDs) of the
/// CimSession(s) that should be removed (terminated).
/// </summary>
[Parameter(
Mandatory = true,
ValueFromPipelineByPropertyName = true,
ParameterSetName = InstanceIdSet)]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public Guid[] InstanceId
{
get
{
return instanceid;
}
set
{
instanceid = value;
base.SetParameter(value, nameInstanceId);
}
}
private Guid[] instanceid;
/// <summary>
/// The following is the definition of the input parameter "Name".
/// Specifies one or more of friendly Names of the CimSession(s) that should be
/// removed (terminated).
/// </summary>
[Parameter(
Mandatory = true,
ValueFromPipelineByPropertyName = true,
ParameterSetName = NameSet)]
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
public string[] Name
{
get
{
return name;
}
set
{
name = value;
base.SetParameter(value, nameName);
}
}
private string[] name;
#endregion
/// <summary>
/// BeginProcessing method.
/// </summary>
protected override void BeginProcessing()
{
this.cimRemoveSession = new CimRemoveSession();
this.AtBeginProcess = false;
}
/// <summary>
/// ProcessRecord method.
/// </summary>
protected override void ProcessRecord()
{
base.CheckParameterSet();
this.cimRemoveSession.RemoveCimSession(this);
}
#region private members
/// <summary>
/// <see cref="CimRemoveSession"/> object used to remove the session from
/// session cache.
/// </summary>
private CimRemoveSession cimRemoveSession;
#region const string of parameter names
internal const string nameCimSession = "CimSession";
internal const string nameComputerName = "ComputerName";
internal const string nameId = "Id";
internal const string nameInstanceId = "InstanceId";
internal const string nameName = "Name";
#endregion
/// <summary>
/// Static parameter definition entries.
/// </summary>
private static readonly Dictionary<string, HashSet<ParameterDefinitionEntry>> parameters = new()
{
{
nameCimSession, new HashSet<ParameterDefinitionEntry> {
new ParameterDefinitionEntry(CimBaseCommand.CimSessionSet, true),
}
},
{
nameComputerName, new HashSet<ParameterDefinitionEntry> {
new ParameterDefinitionEntry(CimBaseCommand.ComputerNameSet, true),
}
},
{
nameId, new HashSet<ParameterDefinitionEntry> {
new ParameterDefinitionEntry(CimBaseCommand.SessionIdSet, true),
}
},
{
nameInstanceId, new HashSet<ParameterDefinitionEntry> {
new ParameterDefinitionEntry(CimBaseCommand.InstanceIdSet, true),
}
},
{
nameName, new HashSet<ParameterDefinitionEntry> {
new ParameterDefinitionEntry(CimBaseCommand.NameSet, true),
}
},
};
/// <summary>
/// Static parameter set entries.
/// </summary>
private static readonly Dictionary<string, ParameterSetEntry> parameterSets = new()
{
{ CimBaseCommand.CimSessionSet, new ParameterSetEntry(1, true) },
{ CimBaseCommand.ComputerNameSet, new ParameterSetEntry(1) },
{ CimBaseCommand.SessionIdSet, new ParameterSetEntry(1) },
{ CimBaseCommand.InstanceIdSet, new ParameterSetEntry(1) },
{ CimBaseCommand.NameSet, new ParameterSetEntry(1) },
};
#endregion
}
}
|