Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
  • Loading branch information
mtboren committed Jan 3, 2018
2 parents 68179ca + 3ffea7d commit 7adda3a
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 23 deletions.
6 changes: 5 additions & 1 deletion ChangeLog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
### ChangeLog for vNugglets.VDNetworking PowerShell module

#### v0.5, still under development Dec 2017
#### v1.0, Jan 2017
- initial public "prod" release of `master` branch
- published module in PowerShell Gallery

#### v0.5, under development in Dec 2017
37 changes: 27 additions & 10 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,32 @@ Some of the functionality provided by the cmdlets in this module:
<a id="quickStart"></a>
### QuickStart
Chomping at the bit to get going with using this module? Of course you are! Go like this:
- Eventually, we'll have this module available in the PowerShell Gallery, but for now: clone the GitHub project to some local folder with Git via:
`PS C:\> git clone https://github.com/vNugglets/vNuggletsPSMod_vDNetworking.git C:\temp\MyVNuggsVDRepoCopy`
- put the actual PowerShell module directory in some place that you like to keep your modules, say, like this, which copies the module to your personal Modules directory:
`PS C:\> Copy-Item -Recurse -Path C:\temp\MyVNuggsVDRepoCopy\vNugglets.VDNetworking\ -Destination ~\Documents\WindowsPowerShell\Modules\vNugglets.VDNetworking`
- import the PowerShell module into the current PowerShell session:
`PS C:\> Import-Module -Name vNugglets.VDNetworking`
or, if the vNugglets.VDNetworking module folder is not in your `Env:\PSModulePath`, specify the whole path to the module folder, like:
`PS C:\> Import-Module -Name \\myserver.dom.com\PSModules\vNugglets.VDNetworking`
- This module available in the PowerShell Gallery! To install it on your machine or to save it for inspection, first, use one of these:
- Install the module:

`Find-Module vNugglets.VDNetworking | Install-Module`
- Or, save the module first for further inspection/distribution (always a good idea):

`Find-Module vNugglets.VDNetworking | Save-Module -Path c:\temp\someFolder`
- If you are not interested in- or able to use the PowerShell Gallery, you can get the module in this way:
- clone the GitHub project to some local folder with Git via:

`PS C:\> git clone https://github.com/vNugglets/vNuggletsPSMod_vDNetworking.git C:\temp\MyVNuggsVDRepoCopy`
- put the actual PowerShell module directory in some place that you like to keep your modules, say, like this, which copies the module to your personal Modules directory:

`PS C:\> Copy-Item -Recurse -Path C:\temp\MyVNuggsVDRepoCopy\vNugglets.VDNetworking\ -Destination ~\Documents\WindowsPowerShell\Modules\vNugglets.VDNetworking`
- import the PowerShell module into the current PowerShell session:

`PS C:\> Import-Module -Name vNugglets.VDNetworking`
- or, if the vNugglets.VDNetworking module folder is not in your `Env:\PSModulePath`, specify the whole path to the module folder when importing, like:

`PS C:\> Import-Module -Name \\myserver.dom.com\PSModules\vNugglets.VDNetworking`

<a id="examplesSection"></a>
### Examples
Examples are forthcoming on the web, but you can always check out the examples for each cmdlet by checking out the help for each cmdlet (see [Getting Help](#gettingHelpSection) section below)
Examples are in two places:
- periodically updated in the docs/ folder for the project at [docs/examples.md](docs/examples.md)
- always up to date in the `Get-Help` examples for each cmdlet by checking out the help for each cmdlet (see [Getting Help](#gettingHelpSection) section below)

<a id="gettingHelpSection"></a>
### Getting Help
Expand All @@ -40,10 +54,13 @@ The cmdlets in this module all have proper help, so you can learn and discover j

<a id="changelog"></a>
### ChangeLog
The [ChangeLog](ChangeLog.md) for this module is, of course, a log of the major changes through the module's hitory. Enjoy the story.
The [ChangeLog](ChangeLog.md) for this module is, of course, a log of the major changes through the module's history. Enjoy the story.

### Other Notes
A few notes on updates to this repo:

Jan 2018
- initial public "prod" release

Dec 2017
- initial public dev release
1 change: 1 addition & 0 deletions Update-ThisModuleManifest.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ begin {
# Confirm = $true
Path = $strFilespecForPsd1
ModuleVersion = "1.0.0"
Author = "Matt Boren (@mtboren)"
CompanyName = 'vNugglets for the VMware PowerCLI community'
Copyright = "MIT License"
Description = "Module with functions for managing VMware vSphere Virtual Distributed Networking components like traffic filtering and marking"
Expand Down
23 changes: 11 additions & 12 deletions vNugglets.VDNetworking/vNugglets.VDNetworking.psd1
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#
# Module manifest for module 'vNugglets.VDNetworking'
#
# Generated by: V2X5333
# Generated by: Matt Boren (@mtboren)
#
# Generated on: 1/3/2018
#
Expand All @@ -18,10 +18,10 @@ ModuleVersion = '1.0.0'
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = 'edd8886c-0385-47ff-be4a-c97d02836946'
GUID = '5ece18bf-0157-44bd-8412-1881d5a35b00'

# Author of this module
Author = 'V2X5333'
Author = 'Matt Boren (@mtboren)'

# Company or vendor of this module
CompanyName = 'vNugglets for the VMware PowerCLI community'
Expand Down Expand Up @@ -80,13 +80,13 @@ FunctionsToExport = 'Get-VNVDTrafficFilterPolicyConfig', 'Get-VNVDTrafficRuleSet
'Remove-VNVDTrafficRule', 'Set-VNVDTrafficRuleSet'

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = @()
CmdletsToExport = '*'

# Variables to export from this module
# VariablesToExport = @()
VariablesToExport = '*'

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = @()
AliasesToExport = '*'

# DSC resources to export from this module
# DscResourcesToExport = @()
Expand All @@ -108,7 +108,9 @@ PrivateData = @{
PSData = @{

# Tags applied to this module. These help with module discovery in online galleries.
Tags = 'vNugglets','VMware','vSphere','PowerCLI','VDPortGroup','TrafficFiltering','Filter','Filtering','TrafficMarking','Mark','Marking','VDSwitch'
Tags = 'vNugglets', 'VMware', 'vSphere', 'PowerCLI', 'VDPortGroup',
'TrafficFiltering', 'Filter', 'Filtering', 'TrafficMarking', 'Mark',
'Marking', 'VDSwitch'

# A URL to the license for this module.
LicenseUri = 'https://github.com/vNugglets/vNuggletsPSMod_vDNetworking/blob/master/License'
Expand All @@ -122,12 +124,9 @@ PrivateData = @{
# ReleaseNotes of this module
ReleaseNotes = 'See release notes at https://github.com/vNugglets/vNuggletsPSMod_vDNetworking/blob/master/ChangeLog.md'

# External dependent modules of this module
# ExternalModuleDependencies = ''

} # End of PSData hashtable
} # End of PrivateData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''
Expand Down

0 comments on commit 7adda3a

Please sign in to comment.