A modern way to keep configuration in file

In Windows environment, we are so used to the INI file or configuration in XML format. You may consider a modern way to keep configuration in a file which uses JSON format.

In Powershell,handling JSON format is quite easy
  • ConvertTo-Json
    • This method converts in object into JSON format.
  • ConvertFrom-Json
    • This method converts the JSON text to an object.
The next recipe is to call Set-Content and Get-Content to update file and load from file respectively.

We develop a simple configuration Powershell which handles the maintenance to the config file. Let's call this file config-my.ps1.

param (
    # list, add, set, delete
    [string]$axn,

    # the name of the setting to be updated.
    [string]$name,

    # new value
    [string]$value
)


# validate user param

if ($axn.Length -eq 0) {

    # default param
    $axn = "list"

}
elseif (($axn -eq "add") -or ($axn -eq "set")) {

    if ($name.Length -eq 0) {
        Write-Output "name or param cannot be blank"
        return
    }

    if ($value.Length -eq 0) {
        Write-Output "value param cannot be blank"
        return
    }

}
elseif ($axn -eq "delete") {

    if ($name.Length -eq 0) {
        Write-Output "name or param cannot be blank"
        return
    }
   
}


#-------------------------------
# shared functions
#-------------------------------

function Get-TimeStamp {   
    return "[{0:yyMMdd} @ {0:HH:mm:ss}]" -f (Get-Date)   
}

$result = New-Object System.Collections.ArrayList

function Append-to-result ($msg2) {
    $ts2 = Get-TimeStamp   
   
    $o = New-Object psobject
    $o | Add-Member -MemberType NoteProperty -Name "time" -Value $ts2
    $o | Add-Member -MemberType NoteProperty -Name "result" -Value $msg2
    $dummy =  $result.Add($o)
}

#-------------------------------
# main process
#-------------------------------

$f = "$PSScriptRoot\my-ps.config"

if (Test-Path $f) {
    $config = (Get-Content -Path $f) | ConvertFrom-Json
}
else {
    $config = New-Object psobject
}


#-------------------
# run the process
#-------------------

if ($axn -eq "list") {

    # returns the settings
    $result = $config

}
elseif ($axn -eq "add") {

    # update the settings
    $b = [bool]($config.PSobject.Properties.name -match $name)

    if ($b) {
         # returns the result
         Append-to-result "$name setting already exist. skip updating"
    }
    else {
        # add new setting
        $config | Add-Member -MemberType NoteProperty -Name $name -Value $value

        # save to file
        $j = $config | ConvertTo-Json  | Set-Content -Path $f

        # returns the result
        Append-to-result "Updated $name setting"
    }
   
}
elseif ($axn -eq "set") {
  
    # update the settings
    $b = [bool]($config.PSobject.Properties.name -match $name)

    if ($b) {
        # update the value
        $config."$name" = $value
    }
    else {
        # add new setting
        $config | Add-Member -MemberType NoteProperty -Name $name -Value $value
    }
   
    # save to file
    $j = $config | ConvertTo-Json  | Set-Content -Path $f

    # returns the result
    Append-to-result "Updated $name setting"


}
elseif ($axn -eq "delete") {

    $b = [bool]($config.PSobject.Properties.name -match $name)
   
    if ($b) {
        $config.psobject.Properties.Remove($name)

         # save to file
        $j = $config | ConvertTo-Json  | Set-Content -Path $f

        # returns the result
        Append-to-result "Deleted $name"

    }
    else {
       
        # returns the result
        Append-to-result "$name setting does not exist"

    }
   
}


#-------------------------------
# result
#-------------------------------

$result | ConvertTo-Json

Comments

Post a Comment

Popular posts from this blog

Scheduled task in Windows Task Scheduler - part 3

This is the last part of Task Scheduler - security context which is created using New-ScheduledTaskPrincipal. Usually, we are using S4U logon type for any server scheduled task + Highest Run Level. S4U details as per MS documentation: Use an existing interactive token to run a task. The user must log on using a service for user (S4U) logon. When an S4U logon is used, no password is stored by the system and there is no access to either the network or encrypted files. You can find more information in this page:     https://docs.microsoft.com/en-us/windows/win32/taskschd/principal-logontype For any user ID that you specified to run the scheduled task, it requires "Log on as a batch job" or "Log on as a service". You can find the details here:     https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/log-on-as-a-batch-job     https://docs.microsoft.com/en-us/windows/security/threat-protection/...
Read more

Create scheduled task in Windows Task Scheduler

Windows Task Scheduler is a utility that helps to execute any process periodically. For example, you want to sync your working files on daily basis, scanning virus, process some data, etc. A task has the following components: Action or multiple actions - which is the process that you want to run periodically. We use New-ScheduledTaskAction to create new action object. Trigger - which is the time to run the process and it can have multiple timing. We use New-ScheduledTaskTrigger to create new trigger. Security context - any process must run in a valid security context. We can set the context using New-ScheduledTaskPrincipal. The following script creates an on demand task which requires user to manually trigger the task. $task_folder = "\myTasks\" $task_name = "myTask2" # this can be any Powershell script. $ps_script_file = "d:\temp5\test-script.ps1" ## The first line will show err if $task_folder does not exist. ## The second line will not...
Read more

Get all website entries in IIS

It's very easy to get the list of the website entries in IIS with 3 lines of code.   Import-Module WebAdministration   cd IIS:\Sites   Get-ChildItem | select name Explanation: 1. We need to import the WebAdministration PS module. This module includes all the necessary API for Powershell to interact with IIS. 2. The second line is to change the current location to IIS Sites folder. 3. Finally, get all the items in the current location.
Read more