Commands for Mac Backup

You can access certain McAfee Online Backup backup software for Mac functionality through a command interface. This is an advanced feature and generally only used by administrators.

Version

Displays version information.

McAfee Online Backup --version

Help

Displays help for the specified command.

McAfee Online Backup help {auth | help | read | rules | start | stop | uninstall | write}

Existing Account Authentication

Authenticate using an existing McAfee Online Backup account.

McAfee Online Backup auth options

Enter any combination of the following for options. The user is prompted for any applicable options not supplied.

--username=username or -U=username

Specifies the backup account username. username is the email address.

--productkey=key or -K=key

Specifies the product key.

--password=password or -P=password

Specifies the password of the backup account.

--passgen=

Generates a random password. If you are using --auto-activation, this is enabled by default. The password is displayed on stdout as "Generated Password:".

New Account Creation and Authentication

Creates a new McAfee Online Backup account and authenticate.

McAfee Online Backup authoptions

Enter ALL of the following for options.

--newuser

Creates a new user. --auto-activation enables this by default.

--displayname=name

Displays the name of the new user (optional when using --auto-activation).

--encryption path

Encryption file URL or path, or 'shared' using shared encryption key.

--username=username

Backup account username (email).

--productkey=key

Specifies the product key.

--password=password

Specifies the password of the backup account.

Display Backup Software Settings

Displays the current value of a backup software setting.

McAfee Online Backup read option

Enter ONE of the following for option.

ad.guid

Shows the GUID used for auto/assisted activation.

ad.ou

Shows the OU used for auto/assisted activation.

auth.type

Shows the default authentication type.

loglevel

Shows the log output level.

general.status.show

Shows whether the status menu is set to display.

general.tmpdir

Displays the temporary file location.

general.update.install

Shows if updates install automatically.

oauth.host

Shows the DNS host name of the authentication service.

schedule

Shows the backup schedule and interval.

setup.timeout

Shows the amount of time the last page in Setup Assistant is displayed. A -1 indicates the page is displayed until manually closed. A 0 indicates the page is suppressed.

throttle.interval

Shows the backup throttle time period.

throttle.rate

Shows the backup throttle rate in bytes per second. -1 turns throttling off.

Set Backup Software Settings

Sets the value of backup software settings.

McAfee Online Backup write option

Enter ONE of the following for option.

auth.typetype

Specifies the default authentication type. For type, enter one of the following options: v2.keyless (authenticate with a username and password), v2.keyed (authenticate with a product key), v2.fedid (authenticate with a username and subdomain).

loglevel output level

Specifies the log output level. output level can be:

• default
• error
• info
• debug
• debug1
• debug2
• debug3

general.status.show choice

Specifies if the status menu is displayed. choice is yes to display the menu and no to hide the menu.

general.cache.disablechoice

Specifies if the backup software keeps temporary copies of recently modified files. Set choice to 1 to disable caching, or set it to 0 to re-enable it.

general.tmpdir path

Specifies the location used for saving temporary files. path is the path to the location.

general.update.install choice

Specifies if software updates are installed automatically. Set choice to yes for automatic updates and no for no stop automatic updates.

oauth.host host name

Specifies the DNS host name of the authentication service. host name is the name of the host.

schedule time

Specifies the backup schedule and interval. time must be entered following conventions for ISO 8601 Interval Representation using week-date-truncated representation and time-of-day-reduced-precision representation in the form -W-dThh:mm/PTdD.

Examples:

• T03:00/P1D means every day at 3:00 AM.
• T17:00/P2D means every other day at 5:00 PM.
• -W-3T01:30/P7D means every week at 1:30 AM on Wednesday.
• -W-7T23:15/P14D means every other week at 11:15PM on Sunday.

Notes:

• The -W-d is only necessary when the period is weekly or bi-weekly.
• The period is limited to P1D, P2D, P7D, and P14D. Other values are rounded to one of these values.
• Time of day references local time, for example, computer time. Any reference to UTC or time zones is not supported.

Note: If a value is not specified, the backup is scheduled automatically.

setup.timeout duration

Specifies the amount of time to display the last page of Setup Assistant. duration is the amount of time in seconds to display the page. A negative value leaves the page displayed until manually closed. A 0 suppresses the page.

throttle.interval interval

Specifies the range of time to throttle backups. interval must conform to ISO 8601 time interval using time-of-day-reduced-precision representation. For example, to throttle backups between 9:00 AM and 5:00 PM computer time, enter 09:00/17:00, 09:00/PT8H, or PT8H/17:00. The default value is 00:00/PT24H.

throttle.nice value

Specifies the operating system scheduling priority for McAfee Online Backup backup tasks. value is a nice value in the range of 0 to 20. The lower the value, the higher the priority. For more information, see information about on the UNIX nice values.

throttle.rate value

Specifies the backup throttle rate. value specifies the throttle rate in Mbits per second.

Uninstall

Uninstalls the McAfee Online Backup backup software for Mac.

McAfee Online Backup uninstall [--removeconfig]

Running this command with no parameters removes the McAfee Online Backup backup software but does not remove the software configuration and log files. Adding the --removeconfig parameter removes the software, configuration files, and log files.

Rules Management

Adds, removes, or lists backup set rules.

McAfee Online Backup rules actions options

Enter any one of the following for actions.

add:path

Adds a new rule. path is the path to and the name of the folder to back up. Note that path is case sensitive, so you must use the exact names of your folders.

remove:path

Removes an existing rule. path is the path to and the name of the folder to remove. Exclusionary and/or forced rules must be denoted using the appropriate option.

list:

Lists existing rules.

Enter any combination of the following for options. The user is prompted for any applicable options not supplied.

--name=name

Specifies the name of the rule to create or delete. If not specified, the last path component of the rule is used.

--query=query

Specifies the query used for the rule to create or delete.

--exclusion

Specifies that the rule created is exclusionary. This is also used to remove exclusionary rules.

--forced

Specify that the newly created rule is forced. This is also used to remove forced rules.

Start Backup

Starts a new backup session unless one is already started.

McAfee Online Backup start

Stop Backup

Stops the current backup session.

McAfee Online Backup stop

Suspend Automatic Backups

McAfee Online Backup write schedule.suspendutil date

Suspend automatic backups until the date given. Current time zone is used. Format must be: yyyy-MM-ddTHH:mm:ss.

Example:

• 2013-12-01T13:00:00 means backups will be suspended until December 1, 2013 at 1:00pm.

Schedule Auto Max Load

Specifies the maximum allowed CPU load percent for starting backups automatically. percentage should be entered as an integer.

McAfee Online Backup write schedule.auto.maxloadpercentage

Example:

McAfee Online Backup write schedule.auto.maxload 90 means less than 90% CPU usage is required for an automatic backup to start.

Schedule Auto Minimum Max Load

Minimum time in minutes the CPU must be below maxload for starting backup automatically. time is the time in minutes the computer must be idle before automatic backups can start.

McAfee Online Backup write scheudule.auto.minidletimetime

Schedule Auto Interval

Minimum time in minutes between automatic backups. minutes should be a whole number. time is the time in minutes between automatic backups.

McAfee Online Backup write scheudule.auto.intervaltime