1. OG_Server-RolesServicesFeatures

    Article: AN0002435Updated: 28.05.2020

    This function returns a list of roles, role services and features of Windows servers. The list of servers is obtained from LDAP (Microsoft Active Directory).

    Main prerequisites for use

    Prerequisite Description

    Module Active Directory PowerShell Microsoft

    		 In order to read information about users from LDAP it is necessary to install Powershell module for Active Directory.
    Remote Differential Compression In order to read information about users from LDAP it is necessary to enable this function of the Windows system on server executing this functionality.
    AD DS and AD LDS Tools In order to read information about users from LDAP it is necessary to enable this function of the Windows system on server executing this functionality.
    Powershell v3 Microsoft Powershell version 3 or higher.

    Description

    Function creates a text file containing information about roles, role services and features according to configuration.

    Name of the column headline Description
    DNS Host Name Name of the server in DNS.
    Name Náame of the server role or feature.
    Display name Displayed name of role or funkce.
    Description Description of role or function.
    Installed Information, whether the role or function is installed (depends on patch level).
    InstallState Information about installation status (Available, Installed, Removed).
    DependsOn Dependence on role or function.
    Depth Role level or function in the tree Turn Windows features On or Off.
    FeatureType Feature type (Feature, Role, RoleService)
    AdditionalInfo Other information
    Notification  
    Parent Parent item in the tree Turn Windows features On or Off.
    SubFeatures Child items in the tree Turn Windows features On or Off.
    SystemService  
    Path Path to the function in the tree Turn Windows features On or Off.
    BestPracticesModelId  

    Parameters

    Include hereinafter stated parameters in the file og_configuration.ps1 (generic parameters shared with other functions) or in the file OG_PC-Start.config (specific parameters of this function). Parameter configuration is described in the documentation of the programme Piklo. 

    Parameter Description Example
    [string]$LogFile Path to the file, in which log of the function shall be stored. [string]$LogFile = "\\servername\OGoutput\Log_Server-Roles-Services-Features.txt"
    [string]$OutFile Path to the file, in which log of the function shall be stored.

    [string]$LogFile = "\\servername\OGoutput\OutFile_Server-Roles-Services-Features.txt"
    [string]$OutFileEncoding Coding of the output file. Possible options are "UTF8", "Unicode", "ANSI" and "DEFAULT". The value "DEFAULT" makes the file being created in the ANSI encoding.

    [string]$OutFileEncoding = "UTF8"
    [string]$Delimiter Delimiter [ ";" | "t" | "," ] - Value separator in the records. [string]$Delimiter = ";"
    [string]$HeaderOutFile Defines, wheather the output file shall include header with column names ("1") or not ("0"). [string]$HeaderOutFile = "1"

    Call

    The function is called by means of the programme Piklo, that is part of ObjectGears package, from ObjectGears script. Result of the call has to be assigned to a variable, with which the script can further work.

    a = OG.Process.RunPiklo('OG_Server-RolesServiceFeatures','-type C')

    In this article
    ×