Cmdlets and scripts should be named using a
Verb-Noun syntax. For example, Get-ChildItem. The official guidance is that, with
rare exception, cmdlets should use the standard PowerShell verbs. They
should avoid any synonyms or concepts that can be mapped to the standard.
This allows administrators to quickly understand a set of cmdlets that use a
new noun.
To quickly access this list (without the definitions), type
Get-Verb.
Verbs should be phrased in the present tense, and nouns should be singular. Tables Table J.1, “Standard Windows PowerShell common verbs” through Table J.6, “Standard Windows PowerShell security verbs” list the different categories of standard PowerShell verbs.
Table J.1. Standard Windows PowerShell common verbs
Verb | Meaning | Synonyms |
|---|---|---|
| Adds a resource to a container, or attaches an element to another element | Append, Attach, Concatenate, Insert |
| Removes all elements from a container | Flush, Erase, Release, Unmark, Unset, Nullify |
| Removes access to a resource | Shut, Seal |
| Copies a resource to another name or container | Duplicate, Clone, Replicate |
| Sets a resource as a context | Push, Telnet, Open |
| Returns to the context that was present before a new context was entered. | Pop, Disconnect |
| Searches within an unknown context for a desired item. | Dig, Discover |
| Converts an item to a specified structure or layout. | Layout, Arrange |
| Retrieves data | Read, Open, Cat, Type, Dir, Obtain, Dump, Acquire, Examine, Find, Search |
| Makes a display not visible | Suppress |
| Joins a resource | Combine, Unite, Connect, Associate |
| Locks a resource | Restrict, Bar |
| Moves a resource | Transfer, Name, Migrate |
| Creates a new resource | Create, Generate, Build, Make, Allocate |
| Enables access to a resource | Release, Unseal |
| Removes an item from the top of a stack | Remove, Paste |
| Puts an item onto the top of a stack | Put, Add, Copy |
| Repeats an action, or reverts the action of an Undo | Repeat, Retry, Revert |
| Removes a resource from a container | Delete, Kill |
| Gives a resource a new name | Ren, Swap |
| Restores a resource to a pre-defined or original state | Restore, Revert |
| Creates a subset of data from a larger data set | Pick, Grep, Filter |
| Finds a resource (or summary information about that resource)in a collection; (does not actually retrieve the resource but provides information to be used when retrieving it) | Find, Get, Grep, Select |
| Places data | Write, Assign, Configure |
| Retrieves, formats, and displays information | Display, Report |
| Bypasses an element in a seek or navigation | Bypass, Jump |
| Separates data into smaller elements | Divide, Chop, Parse |
| Moves a process or navigation forward by one unit | Next, Iterate |
| Alternates the state of a resource between different alternatives or options | Toggle, Alter, Flip |
| Unlocks a resource | Free, Unrestrict |
| Applies or associates a resource with a context | With, Having |
| Continually monitors an item | Monitor, Poll |
Table J.2. Standard Windows PowerShell communication verbs
Verb | Meaning | Synonyms |
|---|---|---|
| Connects a source to a destination | Join, Telnet |
| Disconnects a source from a destination | Break, Logoff |
| Acquires information from a nonconnected source | Prompt, Get |
| Acquires information from a connected source | Read, Accept, Peek |
| Writes information to a connected destination | Put, Broadcast, Mail |
| Writes information to a non-connected destination | Puts, Print |
Table J.3. Standard Windows PowerShell data verbs
Verb | Meaning | Synonyms |
|---|---|---|
| Backs up data | Save, Burn |
| Creates a snapshot of the current state of data, or its configuration | Diff, StartTransaction |
| Compares a resource with another resource | Diff, Bc |
| Reduces the size or resource usage of an item | Zip, Squeeze, Archive |
| Changes from one representation to another, when the cmdlet supports bidirectional conversion, or conversion of many data types | Change, Resize, Resample |
| Converts from one primary input to several supported outputs | Export, Output, Out |
| Converts from several supported inputs to one primary output | Import, Input, In |
| Detaches a name entity from a location in a namespace | Dismount, Unlink |
| Modifies an item in-place | Change, Modify, Alter |
| Increases the size or resource usage of an item | Extract, Unzip |
| Stores the primary input resource into a backing store or interchange format | Extract, Backup |
| Combines an item with other related items | Merge, Combine, Map |
| Creates a primary output resource from a backing store or interchange format | Load, Read |
| Prepares a resource for use, and initializes it to a default state | Setup, Renew, Rebuild |
| Applies constraints to a resource | Quota, Enforce |
| Creates a single data instance from multiple data sets | Combine, Join |
| Attach a named entity to a location in a namespace | Attach, Link |
| Sends data to a terminal location | Print, Format, Send |
| Make a resource known or visible to others | Deploy, Release, Install |
| Restores a resource to a set of conditions that have been predefined or set by a checkpoint | Repair, Return, Fix |
| Stores pending changes to a recoverable store | Write, Retain, Submit |
| Synchronizes two resources with each other | Push, Update |
| Removes a resource from public visibility | Uninstall, Revert |
| Updates or refreshes a resource | Refresh, Renew, Index |
In the Sync row: “Synchronizes two resources with eachother” -> “Synchronizes two resources with each other” (missing space)
Table J.4. Standard Windows PowerShell diagnostic verbs
Verb | Meaning | Synonyms |
|---|---|---|
| Examines a resource, diagnoses operational problems | Attach, Diagnose |
| Identifies resources consumed by an operation, or retrieves statistics about a resource | Calculate, Determine, Analyze |
| Determines if a resource is active and responsive. In most instances, this should be replaced by the verb, Test | Connect, Debug |
| Recovers an item from a damaged or broken state | Fix, Recover, Rebuild |
| Maps a shorthand representation to a more complete one | Expand, Determine |
| Verify the validity or consistency of a resource | Diagnose, Verify, Analyze |
| Follow the activities of the resource | Inspect, Dig |
Table J.5. Standard Windows PowerShell life cycle verbs
Verb | Meaning | Synonyms |
|---|---|---|
| Gives approval or permission for an item or resource | Allow, Let |
| Declares the state of an item or fact | Verify, Check |
| Finalizes a pending operation | Finalize, End |
| Approves or acknowledges a resource or process | Check, Validate |
| Disapproves or disallows a resource or process | Fail, Halt |
| Configures an item to be unavailable | Halt, Hide |
| Configures an item to be available | Allow, Permit |
| Places a resource in the specified location and optionally initializes it | Setup, Configure |
| Calls or launches an activity that cannot be stopped | Run, Call, Perform |
| Adds an item to a monitored or publishing resource | Record, Submit, Journal, Subscribe |
| Submits for consideration or approval | Ask, Query |
| Stops an operation and starts it again | Recycle, Hup |
| Begins an operation after it has been suspended | Continue |
| Begins an activity | Launch, Initiate |
| Discontinues an activity | Halt, End, Discontinue |
| Adds to a list of pending actions, or sends for approval | Send, Post |
| Pauses an operation, but does not discontinue it | Pause, Sleep, Break |
| Removes a resource from the specified location | Remove, Clear, Clean |
| Removes an item from a monitored or publishing resource | Unsubscribe, Erase, Remove |
| To pause until an expected event occurs | Sleep, Pause, Join |
Table J.6. Standard Windows PowerShell security verbs
Verb | Meaning | Synonyms |
|---|---|---|
| Restricts access to a resource | Prevent, Limit, Deny |
| Grants access to a resource | Allow, Enable |
| Limits access to a resource | Encrypt, Seal |
| Removes access to a resource | Remove, Disable |
| Removes a restriction of access to a resource | Clear, Allow |
| Removes restrictions from a protected resource | Decrypt, Decode |
No comments yet
Add a comment