PS_DhcpServerv4Failover, ROOT\Microsoft\Windows\DHCP\MS_409

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

Description

DhcpServer v4Failover

PS_DhcpServerv4Failover methods

PS_DhcpServerv4Failover has 6 methods (6 Local)

NameOriginReturn
AddByHotStandbyPS_DhcpServerv4Failoveruint32 {'out':True}
AddByLoadBalancePS_DhcpServerv4Failoveruint32 {'out':True}
GetByNamePS_DhcpServerv4Failoveruint32 {'out':True}
GetByScopeIdPS_DhcpServerv4Failoveruint32 {'out':True}
RemovePS_DhcpServerv4Failoveruint32 {'out':True}
SetPS_DhcpServerv4Failoveruint32 {'out':True}

Detailed description of PS_DhcpServerv4Failover methods

Local methods (6) of PS_DhcpServerv4Failover class

AddByHotStandby method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerNamestring0-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
Namestring1-{'Description':'Name of the failover relationship to be created','In':True}
PartnerServerstring2-{'Description':'IP address or hostname of the partner server','In':True}
ScopeIdstring3-{'Description':'Scope identifiers (in IPv4 address format) which are to be added to the failover relationship.','In':True}
MaxClientLeadTimedatetime4-{'Description':'Maximum Client Lead time for the failover relationship. Default is 1 hour.','In':True}
AutoStateTransitionboolean5-{'Description':'Enable/Disable automatic state transition from COMMUNICATION INTERRUPTED state to PARTNER DOWN state based on expiry of the timer (Safe Period) while in COMMUNICATION INTERRUPTED state. Valid values are True, False. Default value is False. However, this will be set to True if safe period is specified.','In':True}
StateSwitchIntervaldatetime6-{'Description':'Time interval for which the server should continue to operate in COMMUNICATION INTERRUPTED state before transitioning to PARTNER DOWN state','In':True}
Forceboolean7-{'Description':'If shared secret is specified, user confirmation is sought since shared secret specified may be transferred in clear text transport in case of remote management.','In':True}
SharedSecretstring8-{'Description':'Shared secret to be used for message digest authentication. If not specified, message digest authentication is turned off.','In':True}
PassThruboolean9-{'Description':'If this parameter is specified, the cmdlet returns the PowerShell object which is added.','In':True}
ReservePercentuint3210-{'Description':'Percentage of free IP address pool of the scope which should be reserved on the standby server. In case of a failover, IP address from this reserved pool on the standby server will be leased to new DHCP clients. Default is 5%.','In':True}
ServerRolestring11-{'Description':'Role of the local server in the hot standby mode. Valid values are Active, Standby. Default role is Active for the local server i.e. the partner server specified will be a standby server.','In':True,'Values':['Active', 'Standby']}
cmdletOutputobject:DhcpServerv4Failover12-{'Description':' Type Name Description DhcpServerv4Failover { String Name Unique name for the failover relationship String PartnerServer IP Address or hostname of the partner server String Mode Failover mode; possible values are { HotStandby | LoadBalance} String ServerRole In case of Hot standby, the role of the this server {Active, Standby} else NULL Uint LoadBalancePercent If mode is LoadBalance, the % load allocated to this server If mode is HotStandby, this should be unassigned. Uint ReservePercent If mode is HotStandby; the % of addresses reserved on standby server (0-100) If mode is LoadBalance, this should be unassigned. IPAddress[] ScopeId IDs of one or more Scopes that are part of the failover relationship. TimeSpan MaxClientLeadTime Maximum amount of time that a server can extend a lease for a client?s binding over the lease time known by the partner server Bool AutoStateTransition Enable/Disable automatic transition from COMM_INTERUPTED state to PARTNER_DOWN state {True, False} TimeSpan SafePeriod Time period that the server will stay in COMM_INTERUPTED state before auto transitioning into PARTNER_DOWN state if AutoStateTransition is enabled String State State of the failover relationship { NORMAL, COMMUNICATION_INTERRUPTED, PARTNER_DOWN, POTENTIAL_CONFLICT, STARTUP, RESOLUTION_INTERRUPTED, CONFLICT_DONE, RECOVER, RECOVER_WAIT, RECOVER_DONE, PAUSED, SHUTDOWN, INIT, NO_STATE } Bool EnableAuth Enable/Disable message authentication {True, False} }','Out':True}
Description'Adds a new IPv4 failover relationship on the server.'
AddByHotStandby method is in 1 class (PS_DhcpServerv4Failover) of ROOT\Microsoft\Windows\DHCP\ms_409 and in 2 namespaces
AddByLoadBalance method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerNamestring0-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
Namestring1-{'Description':'Name of the failover relationship to be created','In':True}
PartnerServerstring2-{'Description':'IP address or hostname of the partner server','In':True}
ScopeIdstring3-{'Description':'Scope identifiers (in IPv4 address format) which are to be added to the failover relationship.','In':True}
MaxClientLeadTimedatetime4-{'Description':'Maximum Client Lead time for the failover relationship. Default is 1 hour.','In':True}
AutoStateTransitionboolean5-{'Description':'Enable/Disable automatic state transition from COMMUNICATION INTERRUPTED state to PARTNER DOWN state based on expiry of the timer (Safe Period) while in COMMUNICATION INTERRUPTED state. Valid values are True, False. Default value is False. However, this will be set to True if safe period is specified.','In':True}
StateSwitchIntervaldatetime6-{'Description':'Time interval for which the server should continue to operate in COMMUNICATION INTERRUPTED state before transitioning to PARTNER DOWN state','In':True}
Forceboolean7-{'Description':'If shared secret is specified, user confirmation is sought since shared secret specified may be transferred in clear text transport in case of remote management.','In':True}
SharedSecretstring8-{'Description':'Shared secret to be used for message digest authentication. If not specified, message digest authentication is turned off.','In':True}
PassThruboolean9-{'Description':'If this parameter is specified, the cmdlet returns the PowerShell object which is added.','In':True}
LoadBalancePercentuint3210-{'Description':'Percentage of DHCP client requests which should be served by the local server. The remaining requests would be served by the partner server. Default is 50%.','In':True}
cmdletOutputobject:DhcpServerv4Failover11-{'Description':' Type Name Description DhcpServerv4Failover { String Name Unique name for the failover relationship String PartnerServer IP Address or hostname of the partner server String Mode Failover mode; possible values are { HotStandby | LoadBalance} String ServerRole In case of Hot standby, the role of the this server {Active, Standby} else NULL Uint LoadBalancePercent If mode is LoadBalance, the % load allocated to this server If mode is HotStandby, this should be unassigned. Uint ReservePercent If mode is HotStandby; the % of addresses reserved on standby server (0-100) If mode is LoadBalance, this should be unassigned. IPAddress[] ScopeId IDs of one or more Scopes that are part of the failover relationship. TimeSpan MaxClientLeadTime Maximum amount of time that a server can extend a lease for a client?s binding over the lease time known by the partner server Bool AutoStateTransition Enable/Disable automatic transition from COMM_INTERUPTED state to PARTNER_DOWN state {True, False} TimeSpan SafePeriod Time period that the server will stay in COMM_INTERUPTED state before auto transitioning into PARTNER_DOWN state if AutoStateTransition is enabled String State State of the failover relationship { NORMAL, COMMUNICATION_INTERRUPTED, PARTNER_DOWN, POTENTIAL_CONFLICT, STARTUP, RESOLUTION_INTERRUPTED, CONFLICT_DONE, RECOVER, RECOVER_WAIT, RECOVER_DONE, PAUSED, SHUTDOWN, INIT, NO_STATE } Bool EnableAuth Enable/Disable message authentication {True, False} }','Out':True}
Description'Adds a new IPv4 failover relationship on the server.'
AddByLoadBalance method is in 1 class (PS_DhcpServerv4Failover) of ROOT\Microsoft\Windows\DHCP\ms_409 and in 2 namespaces
GetByName method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerNamestring0-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
Namestring1-{'Description':'Name(s) of the failover relationship(s) whose properties are to be returned','In':True}
cmdletOutputobject:DhcpServerv4Failover2-{'Description':' Type Name Description DhcpServerv4Failover { String Name Unique name for the failover relationship String PartnerServer IP Address or hostname of the partner server String Mode Failover mode; possible values are { HotStandby | LoadBalance} String ServerRole In case of Hot standby, the role of the this server {Active, Standby} else NULL Uint LoadBalancePercent If mode is LoadBalance, the % load allocated to this server. If mode is HotStandby, this should be unassigned. Uint ReservePercent If mode is HotStandby; the % of addresses reserved on standby server (0-100). If mode is LoadBalance, this should be unassigned. IPAddress[] ScopeId IDs of one or more Scopes that are part of the failover relationship. TimeSpan MaxClientLeadTime Maximum amount of time that a server can extend a lease for a client?s binding over the lease time known by the partner server Bool AutoStateTransition Enable/Disable automatic transition from COMM_INTERUPTED state to PARTNER_DOWN state {True, False} TimeSpan SafePeriod Time period that the server will stay in COMM_INTERUPTED state before auto transitioning into PARTNER_DOWN state if AutoStateTransition is enabled String State State of the failover relationship { NORMAL, COMMUNICATION_INTERRUPTED, PARTNER_DOWN, POTENTIAL_CONFLICT, STARTUP, RESOLUTION_INTERRUPTED, CONFLICT_DONE, RECOVER, RECOVER_WAIT, RECOVER_DONE, PAUSED, SHUTDOWN, INIT, NO_STATE } Bool EnableAuth Enable/Disable message authentication {True, False} }','Out':True}
Description'Gets the failover relationships configured on the server for the specific failover relationship name.'
GetByName method is in 1 class (PS_DhcpServerv4Failover) of ROOT\Microsoft\Windows\DHCP\ms_409 and in 6 namespaces
GetByScopeId 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':'Scope identifier(s) (in IPv4 address fromat). Properties of the failover relationships on the server to which these scopes are associated are returned.','In':True}
cmdletOutputobject:DhcpServerv4Failover2-{'Description':' Type Name Description DhcpServerv4Failover { String Name Unique name for the failover relationship String PartnerServer IP Address or hostname of the partner server String Mode Failover mode; possible values are { HotStandby | LoadBalance} String ServerRole In case of Hot standby, the role of the this server {Active, Standby} else NULL Uint LoadBalancePercent If mode is LoadBalance, the % load allocated to this server. If mode is HotStandby, this should be unassigned. Uint ReservePercent If mode is HotStandby; the % of addresses reserved on standby server (0-100). If mode is LoadBalance, this should be unassigned. IPAddress[] ScopeId IDs of one or more Scopes that are part of the failover relationship. TimeSpan MaxClientLeadTime Maximum amount of time that a server can extend a lease for a client?s binding over the lease time known by the partner server Bool AutoStateTransition Enable/Disable automatic transition from COMM_INTERUPTED state to PARTNER_DOWN state {True, False} TimeSpan SafePeriod Time period that the server will stay in COMM_INTERUPTED state before auto transitioning into PARTNER_DOWN state if AutoStateTransition is enabled String State State of the failover relationship { NORMAL, COMMUNICATION_INTERRUPTED, PARTNER_DOWN, POTENTIAL_CONFLICT, STARTUP, RESOLUTION_INTERRUPTED, CONFLICT_DONE, RECOVER, RECOVER_WAIT, RECOVER_DONE, PAUSED, SHUTDOWN, INIT, NO_STATE } Bool EnableAuth Enable/Disable message authentication {True, False} }','Out':True}
Description'Gets the failover relationships configured on the server for the specific failover relationship name.'
GetByScopeId method is in 3 classes of ROOT\Microsoft\Windows\DHCP\ms_409 and in 2 namespaces
Remove method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Namestring0-{'Description':'Name(s) of the failover relationships which are to be removed','In':True}
Forceboolean1-{'Description':'User confirmation of this action is sought by default. If -Force is specified, default user confirmation will not be sought.','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:DhcpServerv4Failover4-{'Description':' Type Name Description DhcpServerv4Failover { String Name Unique name for the failover relationship String PartnerServer IP Address or hostname of the partner server String Mode Failover mode; possible values are { HotStandby | LoadBalance} String ServerRole In case of Hot standby, the role of the this server {Active, Standby} else NULL Uint LoadBalancePercent If mode is LoadBalance, the % load allocated to this server If mode is HotStandby, this should be unassigned. Uint ReservePercent If mode is HotStandby; the % of addresses reserved on standby server (0-100) If mode is LoadBalance, this should be unassigned. IPAddress[] ScopeId IDs of one or more Scopes that are part of the failover relationship. TimeSpan MaxClientLeadTime Maximum amount of time that a server can extend a lease for a client?s binding over the lease time known by the partner server Bool AutoStateTransition Enable/Disable automatic transition from COMM_INTERUPTED state to PARTNER_DOWN state {True, False} TimeSpan SafePeriod Time period that the server will stay in COMM_INTERUPTED state before auto transitioning into PARTNER_DOWN state if AutoStateTransition is enabled String State State of the failover relationship { NORMAL, COMMUNICATION_INTERRUPTED, PARTNER_DOWN, POTENTIAL_CONFLICT, STARTUP, RESOLUTION_INTERRUPTED, CONFLICT_DONE, RECOVER, RECOVER_WAIT, RECOVER_DONE, PAUSED, SHUTDOWN, INIT, NO_STATE } Bool EnableAuth Enable/Disable message authentication {True, False} }','Out':True}
Description'Removes the specified failover relationship(s). The failover relationship will be removed from both the DHCP servers which are part of this failover relationship.'
Remove method is in 21 classes of ROOT\Microsoft\Windows\DHCP\ms_409 and in 18 namespaces
Set method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
ComputerNamestring0-{'Description':'DNS name or IP address of the target computer running the DHCP server service.','In':True}
Namestring1-{'Description':'Name of failover relationship whose properties need to be modified.','In':True}
Forceboolean2-{'Description':'If shared secret is specified, user confirmation is sought since shared secret specified may be transferred in clear text transport in case of remote management.','In':True}
PassThruboolean3-{'Description':'If this parameter is specified, the cmdlet returns the PowerShell object which is modified.','In':True}
ReservePercentuint324-{'Description':'Percentage of free IP address pool of the scope which should be reserved on the standby server. In case of a failover, IP addresses from this reserved pool on the standby server will be leased to new DHCP clients.','In':True}
LoadBalancePercentuint325-{'Description':'Percentage of DHCP client requests which should be served by the local server. The remaining requests would be served by the partner server.','In':True}
MaxClientLeadTimedatetime6-{'Description':'Maximum Client Lead time for the failover relationship.','In':True}
PartnerDownboolean7-{'Description':'Changes the state of the server from Communication Interrupted to Partner Down','In':True}
SharedSecretstring8-{'Description':'Shared secret to be used for message authentication. To turn off message authentication, set the shared secret value to Null.','In':True}
AutoStateTransitionboolean9-{'Description':'Enable/Disable automatic state transition from COMMUNICATION INTERRUPTED state to PARTNER DOWN state based on expiry of the timer (Safe Period) while in COMMUNICATION INTERRUPTED state. Valid values are True, False. Default value is False. However, this will be set to True if safe period is specified.','In':True}
StateSwitchIntervaldatetime10-{'Description':'Time interval for which the server should continue to operate in COMMUNICATION INTERRUPTED state before transitioning to PARTNER DOWN state.','In':True}
Modestring11-{'Description':'Mode of the failover relationship. Possible values are { HotStandby | LoadBalance}.','In':True,'Values':['HotStandby', 'LoadBalance']}
cmdletOutputobject:DhcpServerv4Failover12-{'Description':' Type Name Description DhcpServerv4Failover { String Name Unique name for the failover relationship String PartnerServer IP Address or hostname of the partner server String Mode Failover mode; possible values are { HotStandby | LoadBalance} String ServerRole In case of Hot standby, the role of the this server {Active, Standby} else NULL Uint LoadBalancePercent If mode is LoadBalance, the % load allocated to this server If mode is HotStandby, this should be unassigned. Uint ReservePercent If mode is HotStandby; the % of addresses reserved on standby server (0-100) If mode is LoadBalance, this should be unassigned. IPAddress[] ScopeId IDs of one or more Scopes that are part of the failover relationship. TimeSpan MaxClientLeadTime Maximum amount of time that a server can extend a lease for a client?s binding over the lease time known by the partner server Bool AutoStateTransition Enable/Disable automatic transition from COMM_INTERUPTED state to PARTNER_DOWN state {True, False} TimeSpan SafePeriod Time period that the server will stay in COMM_INTERUPTED state before auto transitioning into PARTNER_DOWN state if AutoStateTransition is enabled String State State of the failover relationship { NORMAL, COMMUNICATION_INTERRUPTED, PARTNER_DOWN, POTENTIAL_CONFLICT, STARTUP, RESOLUTION_INTERRUPTED, CONFLICT_DONE, RECOVER, RECOVER_WAIT, RECOVER_DONE, PAUSED, SHUTDOWN, INIT, NO_STATE } Bool EnableAuth Enable/Disable message authentication {True, False} }','Out':True}
Description'Modifies the attributes of an existing failover relationship.
If the failover mode of relation is LoadBalance or is being changed to LoadBalance, LoadBalancePercent, MaxClientLeadTime, SafePeriod, AutoStateTransition, SharedSecret, State can be specified.
If the failover mode of relation is HotStandby or is being changed to HotStandby, ReservePercent, MaxClientLeadTime, SafePeriod, AutoStateTransition, SharedSecret, State can be specified.
Specifying a param other than this, will lead to a TE.
If sharedsecret is specified a value other than null, EnableAuth will be set to true.
If null is specified for sharedsecret, enableauth will be set to false in the data structure.
If mode is being changes, default confirmation will be sought.
If sharedsecret is specified, default confirmation will be sought intimating the user that the shared secret may be transported in the clear on the network.
'
Set method is in 20 classes of ROOT\Microsoft\Windows\DHCP\ms_409 and in 20 namespaces

PS_DhcpServerv4Failover Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AMENDMENTTrue
Description'DhcpServer v4Failover'
LOCALE'MS_409'

PS_DhcpServerv4Failover System properties

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

Similar Classes to PS_DhcpServerv4Failover

Number of classes:3
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
DhcpServerv4Failover0170----
PS_DhcpServerv4FailoverReplication002----
PS_DhcpServerv4FailoverScope002----
comments powered by Disqus
online utility - toplist
WUtils.com