PS_DhcpServerv4Scope, ROOT\Microsoft\Windows\DHCP

Class | Methods (5) | Properties | Qualifiers (5) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

PS_DhcpServerv4Scope

PS_DhcpServerv4Scope methods

PS_DhcpServerv4Scope has 5 methods (5 Local)

NameOriginReturn
AddPS_DhcpServerv4Scopeuint32 {'out':True}
GetPS_DhcpServerv4Scopeuint32 {'out':True}
RemovePS_DhcpServerv4Scopeuint32 {'out':True}
SetByWithoutRangePS_DhcpServerv4Scopeuint32 {'out':True}
SetByWithRangePS_DhcpServerv4Scopeuint32 {'out':True}

Detailed description of PS_DhcpServerv4Scope methods

Local methods (5) of PS_DhcpServerv4Scope class

Add method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerNamestring0-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
StartRangestring1-{'Description':'Start IP address of the range within the subnet from which IP addresses should be leased by the server.','In':True}
EndRangestring2-{'Description':'End IP address of the range within the subnet from which IP addresses should be leased by the server.','In':True}
Namestring3-{'Description':'Name of the IPv4 scope being added.','In':True}
Descriptionstring4-{'Description':'Description string for the IPv4 scope being added.','In':True}
Statestring5-{'Description':'This specified if the scope should be created in active or inactive state. Valid values are {Active, Inactive}. Only an active scope will respond to client requests. Default value is Active','In':True,'ValueMap':['Active', 'InActive'],'Values':['Active', 'InActive']}
SuperscopeNamestring6-{'Description':'The name of the superscope to which the scope will be added.','In':True}
MaxBootpClientsuint327-{'Description':'If the scope type is specified as Both to allow for both DHCP and BOOTP clients, this parameter allows to specify the maximum number of bootp clients which should be leased an IP address from this scope.','In':True}
ActivatePoliciesboolean8-{'Description':'This specifies if the policy enforcement is to be enabled/disabled on the scope being added. Default value is true (enabled).','In':True}
PassThruboolean9-{'Description':'If this parameter is specified, the cmdlet returns the PowerShell object which is added.','In':True}
NapEnableboolean10-{'Description':'This parameter specifies whether NAP should be enabled for this scope or not. If NAP is enabled, DHCP server passes on the SoH (statement of health) received from the client to the NPS server. Based on the NAP profile set, NPS server determines the network access to be granted to the client.','In':True}
NapProfilestring11-{'Description':'The NAP profile should be set only if NAP is enabled on the scope. The NAP profile refers to the MS Service Class which is a condition used in network policies on NPS.','In':True}
Delayuint1612-{'Description':'Specifies the number of milliseconds by which the server should wait before responding to the client requests. This should be configured if the scope is part of a split scope deployment and this server should act as a secondary server for the scope being added.','In':True}
LeaseDurationdatetime13-{'Description':'The time interval for which an IP address should be leased to a client in this scope. This should be specified in the format day.hrs:mins:secs','In':True}
SubnetMaskstring14-{'Description':'The subnet mask for the scope specified in IP address format. For example: 255.255.255.0.','In':True}
Typestring15-{'Description':'The type of clients to be serviced by the scope. Valid values are DHCP, BOOTP, BOTH.','In':True,'ValueMap':['Dhcp', 'Bootp', 'Both'],'Values':['Dhcp', 'Bootp', 'Both']}
cmdletOutputobject:DhcpServerv4Scope16-{'Description':'Type Name Description DhcpServerv4Scope { IPAddress ScopeId Scope identifier string Name Scope name string Description Scope description string SuperscopeName Superscope Name string SubnetMask Subnet mask of the subnet where this scope serves IPAddress StartRange Start of scope IP range IPAddress EndRange End of scope IP range DateTime LeaseDuration Lease duration configured on this scope string NapProfile NAP profile bool NapEnable Indicates whether NAP is enabled or not ushort Delay Delay (in ms) with which server leases addresses from this scope string State Scope state; valid values are (Active, Inactive) string Type Protocol type supported; valid values are {Dhcp, Bootp, Both} uint MaxBootpClients Maximum number of BOOTP clients configured to be allowed in the Scope. Will be set to 0 if Type is Dhcp or Both }','EmbeddedInstance':'DhcpServerv4Scope','Out':True}
Description'Adds an IPv4 scope on the server'
implementedTrue
staticTrue
Add method is in 21 classes of ROOT\Microsoft\Windows\DHCP and in 17 namespaces
Get method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerNamestring0-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
ScopeIdstring1-{'Description':'The scope identifier(s) (in IPv4 address format) whose configuration is to be retrieved.','In':True}
cmdletOutputobject:DhcpServerv4Scope2-{'Description':' Type Name Description DhcpServerv4Scope { IPAddress ScopeId Scope identifier string Name Scope name string Description Scope description string SuperscopeName Superscope Name string SubnetMask Subnet mask of the subnet where this scope serves IPAddress StartRange Start of scope IP range IPAddress EndRange End of scope IP range DateTime LeaseDuration Lease duration configured on this scope string NapProfile NAP profile bool NapEnable Indicates whether NAP is enabled or not ushort Delay Delay (in ms) with which server leases addresses from this scope string State Scope state; valid values are (Active, Inactive) string Type Protocol type supported; valid values are {Dhcp, Bootp, Both} uint MaxBootpClients Maximum number of BOOTP clients configured to be allowed in the Scope. Will be set to 0 if Type is Dhcp or Both }','EmbeddedInstance':'DhcpServerv4Scope','Out':True,'Stream':True}
Description'Returns the IPv4 scope configuration of the specified scopes. If scope id is not specified all the scopes configured on the server are returned.'
implementedTrue
staticTrue
Get method is in 38 classes of ROOT\Microsoft\Windows\DHCP and in 19 namespaces
Remove method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ScopeIdstring0-{'Description':'Scope identifier(s) (in IPv4 address format) which are to be deleted','In':True}
Forceboolean1-{'Description':'If specified, deletes the scope even if there are active leases in the scope','In':True}
Passthruboolean2-{'Description':'If this parameter is specified, the cmdlet return the PowerShell objects which are deleted.','In':True}
ComputerNamestring3-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
cmdletOutputobject:DhcpServerv4Scope4-{'Description':' Type Name Description DhcpServerv4Scope { IPAddress ScopeId Scope identifier string Name Scope name string Description Scope description string SuperscopeName Superscope Name string SubnetMask Subnet mask of the subnet where this scope serves IPAddress StartRange Start of scope IP range IPAddress EndRange End of scope IP range DateTime LeaseDuration Lease duration configured on this scope string NapProfile NAP profile bool NapEnable Indicates whether NAP is enabled or not ushort Delay Delay (in ms) with which server leases addresses from this scope string State Scope state; valid values are (Active, Inactive) string Type Protocol type supported; valid values are {Dhcp, Bootp, Both} uint MaxBootpClients Maximum number of BOOTP clients configured to be allowed in the Scope. Will be set to 0 if Type is Dhcp or Both }','EmbeddedInstance':'DhcpServerv4Scope','Out':True}
Description'Deletes the specified IPv4 scopes from the Server'
implementedTrue
staticTrue
Remove method is in 21 classes of ROOT\Microsoft\Windows\DHCP and in 18 namespaces
SetByWithoutRange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ActivatePoliciesboolean0-{'Description':'This specifies if the policy enforcement is to be enabled/disabled on the scope. Valid values are True, False.','In':True}
PassThruboolean1-{'Description':'If this parameter is specified, the cmdlet returns the PowerShell object which is modified.','In':True}
Typestring2-{'Description':'Type of the scope. Valid values are DHCP, BOOTP and BOTH. The type of the scope determines if the server will respond to only DHCP client requests, only BOOTP client requests or Both types of clients.','In':True,'ValueMap':['Dhcp', 'Bootp', 'Both'],'Values':['Dhcp', 'Bootp', 'Both']}
ScopeIdstring3-{'Description':'Scope identifier (in IPv4 address format) whose properties are being set','In':True}
Descriptionstring4-{'Description':'Description to be set for the scope','In':True}
LeaseDurationdatetime5-{'Description':'Duration of the IPv4 address lease to be given for the clients of this scope','In':True}
Namestring6-{'Description':'Name to be set for the scope','In':True}
NapEnableboolean7-{'Description':'Enable/Disable NAP for the scope. Valid values are True, False.','In':True}
NapProfilestring8-{'Description':'If NAP is enabled for the scope, the name of the NAP profile to be used for clients in the scope. The NAP profile refers to the MS Service Class which is a condition used in network policies on NPS.','In':True}
Delayuint169-{'Description':'Time in milliseconds by which the server should delay sending a response to clients. This setting should be used on the secondary server in a split scope configuration.','In':True}
Statestring10-{'Description':'State of the scope. Valid values are Active and InActive.','In':True,'ValueMap':['Active', 'InActive'],'Values':['Active', 'InActive']}
SuperscopeNamestring11-{'Description':'Name of the superscope to which this scope is to be added. ','In':True}
ComputerNamestring12-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
MaxBootpClientsuint3213-{'Description':'If the scope supports both types of clients (Bootp, Dhcp), maximum number of bootp clients to be permitted to get an IP address lease from the scope.','In':True}
cmdletOutputobject:DhcpServerv4Scope14-{'Description':' Type Name Description DhcpServerv4Scope { IPAddress ScopeId Scope identifier string Name Scope name string Description Scope description string SuperscopeName Superscope Name string SubnetMask Subnet mask of the subnet where this scope serves IPAddress StartRange Start of scope IP range IPAddress EndRange End of scope IP range DateTime LeaseDuration Lease duration configured on this scope string NapProfile NAP profile bool NapEnable Indicates whether NAP is enabled or not ushort Delay Delay (in ms) with which server leases addresses from this scope string State Scope state; valid values are (Active, Inactive) string Type Protocol type supported; valid values are {Dhcp, Bootp, Both} uint MaxBootpClients Maximum number of BOOTP clients configured to be allowed in the Scope. Will be set to 0 if Type is Dhcp or Both }','EmbeddedInstance':'DhcpServerv4Scope','Out':True}
Description'Sets the properties of an existing IPv4 Scope on the server'
implementedTrue
staticTrue
SetByWithoutRange method is in 1 class (PS_DhcpServerv4Scope) of ROOT\Microsoft\Windows\DHCP and in 2 namespaces
SetByWithRange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ActivatePoliciesboolean0-{'Description':'This specifies if the policy enforcement is to be enabled/disabled on the scope. Valid values are True, False.','In':True}
PassThruboolean1-{'Description':'If this parameter is specified, the cmdlet returns the PowerShell object which is modified.','In':True}
ScopeIdstring2-{'Description':'Scope identifier (in IPv4 address format) whose properties are being set','In':True}
Namestring3-{'Description':'Name to be set for the scope','In':True}
Statestring4-{'Description':'State of the scope. Valid values are Active and InActive.','In':True,'ValueMap':['Active', 'InActive'],'Values':['Active', 'InActive']}
LeaseDurationdatetime5-{'Description':'Duration of the IPv4 address lease to be given for the clients of this scope','In':True}
Delayuint166-{'Description':'Time in milliseconds by which the server should delay sending a response to clients. This setting should be used on the secondary server in a split scope configuration.','In':True}
NapEnableboolean7-{'Description':'Enable/Disable NAP for the scope. Valid values are True, False.','In':True}
SuperscopeNamestring8-{'Description':'Name of the superscope to which this scope is to be added. ','In':True}
MaxBootpClientsuint329-{'Description':'If the scope supports both types of clients (Bootp, Dhcp), maximum number of bootp clients to be permitted to get an IP address lease from the scope.','In':True}
NapProfilestring10-{'Description':'If NAP is enabled for the scope, the name of the NAP profile to be used for clients in the scope. The NAP profile refers to the MS Service Class which is a condition used in network policies on NPS.','In':True}
StartRangestring11-{'Description':'Start address of the IPv4 range to be set for the scope. If a new IP range is being set, the previously set IP range of the scope is discarded.','In':True}
EndRangestring12-{'Description':'End address of the IPv4 range to be set for the scope. If a new IP range is being set, the previously set IP range of the scope is discarded.','In':True}
Descriptionstring13-{'Description':'Description to be set for the scope','In':True}
Typestring14-{'Description':'Type of the scope. Valid values are DHCP, BOOTP and BOTH. The type of the scope determines if the server will respond to only DHCP client requests, only BOOTP client requests or Both types of clients.','In':True,'ValueMap':['Dhcp', 'Bootp', 'Both'],'Values':['Dhcp', 'Bootp', 'Both']}
ComputerNamestring15-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
cmdletOutputobject:DhcpServerv4Scope16-{'Description':' Type Name Description DhcpServerv4Scope { IPAddress ScopeId Scope identifier string Name Scope name string Description Scope description string SuperscopeName Superscope Name string SubnetMask Subnet mask of the subnet where this scope serves IPAddress StartRange Start of scope IP range IPAddress EndRange End of scope IP range DateTime LeaseDuration Lease duration configured on this scope string NapProfile NAP profile bool NapEnable Indicates whether NAP is enabled or not ushort Delay Delay (in ms) with which server leases addresses from this scope string State Scope state; valid values are (Active, Inactive) string Type Protocol type supported; valid values are {Dhcp, Bootp, Both} uint MaxBootpClients Maximum number of BOOTP clients configured to be allowed in the Scope. Will be set to 0 if Type is Dhcp or Both }','EmbeddedInstance':'DhcpServerv4Scope','Out':True}
Description'Sets the properties of an existing IPv4 Scope on the server'
implementedTrue
staticTrue
SetByWithRange method is in 1 class (PS_DhcpServerv4Scope) of ROOT\Microsoft\Windows\DHCP and in 2 namespaces

PS_DhcpServerv4Scope Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
ClassVersion'1.0.0'
Description'PS_DhcpServerv4Scope'
dynamicTrue
locale'MS_409'
provider'DhcpServerPSProvider'

PS_DhcpServerv4Scope System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Microsoft\Windows\DHCP:PS_DhcpServerv4Scope'___SYSTEM8
__NAMESPACE'ROOT\Microsoft\Windows\DHCP'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION[]___SYSTEM8
__PROPERTY_COUNT0___SYSTEM3
__RELPATH'PS_DhcpServerv4Scope'___SYSTEM8
__DYNASTY'PS_DhcpServerv4Scope'___SYSTEM8
__SUPERCLASSnull___SYSTEM8
__CLASS'PS_DhcpServerv4Scope'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to PS_DhcpServerv4Scope

Number of classes:3
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
DhcpServerv4Scope0150----
DhcpServerv4ScopeStatistics0110----
PS_DhcpServerv4ScopeStatistics001----
comments powered by Disqus
WUtils.com