client
The client object allows access to properties of the client application hosting the relevance evaluation, typically a BigFix program. In addition, the client maintains a collection of settings with both name and value properties that are inspectable using the client object. These inspectors share properties of application types, such as version and size.
| Version | Platforms |
|---|---|
| 8.0.584.0 | AIX, HP-UX, Mac, Red Hat, SUSE, Solaris, Windows |
| 8.1.535.0 | Debian, Ubuntu |
| 9.5.13.130 | Raspbian |
Creation
Returns the client object corresponding to the BigFix application evaluating the current relevance expression. This is equivalent to the file system object of the BigFix Client executable.
| Version | Platforms |
|---|---|
| 8.0.584.0 | AIX, HP-UX, Mac, Red Hat, SUSE, Solaris, Windows |
| 8.1.535.0 | Debian, Ubuntu |
| 9.5.13.130 | Raspbian |
Properties
If the administrator named in the <string> is enabled on the given <client> computer, this property returns a setting with the given name and the value 'allow.' For instance, if the name of the administrator is joe_admin, then the client would return a setting object with the name 'joe_admin' and a value of 'allow'. Casting this as a string would return 'joe_admin=allow'.
| Version | Platforms |
|---|---|
| 8.0.584.0 | AIX, HP-UX, Mac, Red Hat, SUSE, Solaris, Windows |
| 8.1.535.0 | Debian, Ubuntu |
| 9.5.13.130 | Raspbian |
Returns the type of the identity provider that the computer is joined to. Otherwise, if no fallback client setting is set, returns an error. The possible return values are:
ActiveDirectory, if the computer is joined to Active DirectoryEntraID, if the computer is joined to Entra IDManual, if the client settings_BESClient_ManageBy_UserPrincipalNameor_BESClient_ManageBy_MemberOfare set.
- Q: idp directory type of client
- A: ActiveDirectory
| Version | Platforms |
|---|---|
| 11.0.7.0 | AIX, Debian, Mac, Raspbian, Red Hat, SUSE, Solaris, Ubuntu, Windows |
If the computer is joined to an Active Directory, returns the computer's display name or, if that field is empty, its NetBIOS computer name. If the computer is joined to Entra ID, returns the computer's display name. Returns an error if this information is not available.
- Q: idp display name of client
- A: BOB-RELAY
| Version | Platforms |
|---|---|
| 11.0.7.0 | AIX, Debian, Mac, Raspbian, Red Hat, SUSE, Solaris, Ubuntu, Windows |
If the computer is joined to an Active Directory, returns the computer's LDAP distinguished name. Otherwise, returns an error.
- Q: idp distinguished name of client
- A: cn=bob-ubuntu22,cn=computers,dc=idptest,dc=local
| Version | Platforms |
|---|---|
| 11.0.7.0 | AIX, Debian, Mac, Raspbian, Red Hat, SUSE, Solaris, Ubuntu, Windows |
If the computer is joined to an identity provider, returns a list of objects representing the groups it belongs to. Otherwise, returns an error.
- Q: names of idp groups of client
- A: WinLaptop
- A: Rome Lab Computers
| Version | Platforms |
|---|---|
| 11.0.7.0 | AIX, Debian, Mac, Raspbian, Red Hat, SUSE, Solaris, Ubuntu, Windows |
If the computer is joined to Active Directory, returns the computer's SAM account name. Otherwise, returns an error.
- Q: idp sam account name of client
- A: BOB-UBUNTU22$
| Version | Platforms |
|---|---|
| 11.0.7.0 | AIX, Debian, Mac, Raspbian, Red Hat, SUSE, Solaris, Ubuntu, Windows |
If the computer is joined to an identity provider, returns an object representing the user that manages it. Otherwise, returns an error.
- Q: exists idp user of client
- A: True
| Version | Platforms |
|---|---|
| 11.0.7.0 | AIX, Debian, Mac, Raspbian, Red Hat, SUSE, Solaris, Ubuntu, Windows |
This inspector returns the MAC address that the specified BigFix client registered with.Example: registration mac address of client - Returns a MAC address such as 00-1e-c9-4d-ce-5c.
| Version | Platforms |
|---|---|
| 8.0.584.0 | AIX, HP-UX, Mac, Red Hat, SUSE, Solaris, Windows |
| 8.1.535.0 | Debian, Ubuntu |
| 9.5.13.130 | Raspbian |
This inspector returns the subnet address (as an <ipv4or6 address> type) from the adapter that the specified BigFix client registered with.
| Version | Platforms |
|---|---|
| 8.0.584.0 | AIX, HP-UX, Mac, Red Hat, SUSE, Solaris, Windows |
| 8.1.535.0 | Debian, Ubuntu |
| 9.5.13.130 | Raspbian |
Returns a status message string indicating No Progress, Errors or a string like the following to indicate the upload progress:<filename>: x of <filesize> bytes in <number> seconds.
| Version | Platforms |
|---|---|
| 8.0.584.0 | AIX, HP-UX, Mac, Red Hat, SUSE, Solaris, Windows |
| 8.1.535.0 | Debian, Ubuntu |
| 9.5.13.130 | Raspbian |
The product version of the BES application (BESClient or QnA).Note: On the Macintosh only, this inspector returns a <string>.Example: version of client as string - Returns a string like "4.0.3.7".
| Version | Platforms |
|---|---|
| 8.0.584.0 | AIX, HP-UX, Mac, Red Hat, SUSE, Solaris |
| 8.1.535.0 | Debian, Ubuntu |
| 9.5.13.130 | Raspbian |