PublicIPAddress.psd1
|
# # Module manifest for module 'PublicIPAddress' # # Generated by: Juho Lehto # # Generated on: 21.11.2016 # @{ # Script module or binary module file associated with this manifest. RootModule = 'PublicIPAddress.psm1' # Version number of this module. ModuleVersion = '1.1.1' # Supported PSEditions # CompatiblePSEditions = @() # ID used to uniquely identify this module GUID = '2bf8f96c-ad3b-4239-9269-15326ea2b926' # Author of this module Author = 'Juho Lehto' # Company or vendor of this module CompanyName = '' # Copyright statement for this module Copyright = '(c) 2016 Juho Lehto. All rights reserved.' # Description of the functionality provided by this module Description = 'PublicIPAddress is a PowerShell module for querying public IPv4/IPv6-address and save the IP-address to a file. Optionally can also create a scheduled task to do this periodically. Most Internet-connections, especially wireless connections have dynamic IP-address that will change at times. As such it may prove to be challenging to remotely connect to your computer from the Internet. One of the most popular ways to address the issue is to use a service such as DynDNS which provices a static hostname, eg myhomecomputer.domain.net. But unless you actually need to use a static hostname, an alternative way is to leverage Dropbox, OneDrive, Google Drive or similar cloud service to store public IP-address of your computer in a file. All you need is a way to periodically check current public IP-address and save that to a file located in a directory that will be synced to a cloud service, which you can then read on your phone or any other computer with access to the Internet. This PowerShell module provides a function to check current public IP-address and write the IP-address to a file in specified directory. In addition to this, a scheduled task can be created to do this periodically. If you intend to use a scheduled task, this module should be installed to %systemdrive%:\Program Files\WindowsPowerShell\Modules. Otherwise SYSTEM account cannot find this module and use its functions. Administrator privileges will also be required to create a scheduled task. When installing this module from the PowerShell Gallery, use "Install-Module -Name PublicIPAddress -Scope AllUsers" in order to install the module to Program Files. Queries for IP-address should be limited to no more than once per five minutes. Otherwise your queries my be dropped.' # Minimum version of the Windows PowerShell engine required by this module PowerShellVersion = '3.0' # Name of the Windows PowerShell host required by this module # PowerShellHostName = '' # Minimum version of the Windows PowerShell host required by this module # PowerShellHostVersion = '' # Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only. # DotNetFrameworkVersion = '' # Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only. # CLRVersion = '' # Processor architecture (None, X86, Amd64) required by this module # ProcessorArchitecture = '' # Modules that must be imported into the global environment prior to importing this module # RequiredModules = @() # Assemblies that must be loaded prior to importing this module # RequiredAssemblies = @() # Script files (.ps1) that are run in the caller's environment prior to importing this module. # ScriptsToProcess = @() # Type files (.ps1xml) to be loaded when importing this module # TypesToProcess = @() # Format files (.ps1xml) to be loaded when importing this module # FormatsToProcess = @() # Modules to import as nested modules of the module specified in RootModule/ModuleToProcess # NestedModules = @() # Functions 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 functions to export. FunctionsToExport = @('Get-PublicIPAddress', 'Save-PublicIPAddress') # 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 = @() # Variables to export from this module 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 = @() # DSC resources to export from this module # DscResourcesToExport = @() # List of all modules packaged with this module # ModuleList = @() # List of all files packaged with this module # FileList = @() # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell. PrivateData = @{ PSData = @{ # Tags applied to this module. These help with module discovery in online galleries. Tags = @('IPv4', 'IPv6', 'IP', 'IP-address') # A URL to the license for this module. LicenseUri = 'https://raw.githubusercontent.com/KeeperB5/PublicIPAddress/master/LICENSE' # A URL to the main website for this project. ProjectUri = 'https://github.com/KeeperB5/PublicIPAddress' # A URL to an icon representing this module. # IconUri = '' # ReleaseNotes of this module ReleaseNotes = '1.0 - Initial release. 1.1 - Save-PublicIPAddress now checks that PowerShell is running with Administrator privileges when using the ScheduledTask switch. Appropriate error message is thrown when running with insufficient privileges. - Save-PublicIPAddress now creates scheduled task to run as NT AUTHORITY\SYSTEM account, instead of NT AUTHORITY\LOCAL SERVICE. The LOCAL SERVICE account may not have sufficient filesystem permissions to the directory given as argument to the Path parameter, whereas SYSTEM should. - Updated description of this module. 1.1.1 - Missed one reference to LOCAL SERVICE, which has now been changed to SYSTEM.' } # End of PSData hashtable } # End of PrivateData hashtable # HelpInfo URI of this module # HelpInfoURI = '' # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix. # DefaultCommandPrefix = '' } |