STtools.psd1

#
# Module manifest for module 'PSGet_STtools'
#
# Generated by: Eric van de Paverd
#
# Generated on: 13/08/2018
#

@{

# Script module or binary module file associated with this manifest.
RootModule = '.\STtools.psm1'

# Version number of this module.
ModuleVersion = '1.2.6'

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = 'fc6e4633-95f6-4c99-a3db-b764729461f1'

# Author of this module
Author = 'Eric van de Paverd'

# Company or vendor of this module
CompanyName = 'Unknown'

# Copyright statement for this module
Copyright = '(c) 2018 Eric van de Paverd. All rights reserved.'

# Description of the functionality provided by this module
Description = 'Tools for school system admins. Currently setting groups based on arbitrary CSV files is implemented.
 
Examples:
 
# Year level groups for students
# Students are assigned to groups according to their year level based n their SCHOOL_YEAR in CASES
# eg. Year7, Year8, ...
Get-STGroupsFromCSV -csvfile "\\path\to$\STUDENT.csv" -prefix "Year" -username_header "STKEY" -group_header "SCHOOL_YEAR" -stripzeros -filter {$_.STATUS -eq "ACTV"} |ForEach-Object {
    Remove-ADGroupMember -Identity $_.Identity -Members $_.NonMembers -Confirm:$false -PassThru
    Add-ADGroupMember -Identity $_.Identity -Members $_.Members -Confirm:$false -PassThru
}
 
# Year level groups for staff
# Staff are assigned to groups according to the year levels of classes in their timetabler
# eg. 7teachers, 8teachers ...
Get-STGroupsFromCSV -csvfile "\\path\to\classes\taught.csv" -username_header "Teacher Code" -group_header "Roll Class Code" -postfix teachers -onlynumbers |ForEach-Object {
    Remove-ADGroupMember -Identity $_.Identity -Members $_.NonMembers -Confirm:$false -PassThru
    Add-ADGroupMember -Identity $_.Identity -Members $_.Members -Confirm:$false -PassThru
}
 
# Staff group
# Staff are assigned to the Staff group according to them being active in CASES
Get-STGroupsFromCSV -csvfile "\\path\to\file\with\staff.csv" -username_header "SFKEY" -group_name "Staff" -filter {$_.STAFF_STATUS -eq "ACTV"} |ForEach-Object {
    Remove-ADGroupMember -Identity $_.Identity -Members $_.NonMembers -Confirm:$false -PassThru
    Add-ADGroupMember -Identity $_.Identity -Members $_.Members -Confirm:$false -PassThru
}
 
# Class groups for students
# Students are assigned to groups according to classes they have in timetabler
# eg. 07ENG1, 08ENG3, ...
Get-STGroupsFromCSV -csvfile "\\path\to\file\with\classes.csv" -username_header "Student Code" -group_header "Class Code" |ForEach-Object {
    Remove-ADGroupMember -Identity $_.Identity -Members $_.NonMembers -Confirm:$false -PassThru
    Add-ADGroupMember -Identity $_.Identity -Members $_.Members -Confirm:$false -PassThru
}
'


# Minimum version of the Windows PowerShell engine required by this module
# PowerShellVersion = ''

# 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 = @('NTFSSecurity')

# 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 = 'STtools.format.ps1xml'

# 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-STGroupsFromCSV', 'Set-STOrganizationalUnit', 'New-STUser', 
               'Set-STUser', 'ConvertFrom-STEduHubST', 'ConvertFrom-STEduHubSF'

# 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.

# 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 = @()

        # A URL to the license for this module.
        # LicenseUri = ''

        # A URL to the main website for this project.
        # ProjectUri = ''

        # A URL to an icon representing this module.
        # IconUri = ''

        # ReleaseNotes of this module
        ReleaseNotes = 'ensure that email is only sent if account is successfully created'

        # Prerelease string of this module
        # Prerelease = ''

        # Flag to indicate whether the module requires explicit user acceptance for install/update
        # RequireLicenseAcceptance = $false

        # External dependent modules of this module
        # ExternalModuleDependencies = @()

    } # 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 = ''

}