snlicense(8) snlicense(8)
NAME
snlicense - Report Xsan license status
SYNOPSIS
snlicense [-t] [-v|-m|-h] [-f license-file] license_type [nocap]
DESCRIPTION
snlicense will report on the current license status for the license
type indicated. It will report if the license is missing. It will also
report on the expiration date and capacity for the license if it is
present. The currently supported license types can be displayed by
typing snlicense -h.
The optional nocap argument is for internal use only to prevent a hang
when certain components are not fully initialized.
OPTIONS
-t Will create temporary licenses if license.dat does not exist
-v Will cause more license info to be reported
-m Will cause the output to be printed in a machine readable format
-f license-file
Will use an alternative license file. The default license file
is /Library/Preferences/Xsan/license.dat.
USAGE
Simply execute the program with the desired license type. See examples
below for more info.
LICENSE EXPIRATION
When one license has expired all access to licensed features is sus-
pended with the exception of the maintenance and proxy licenses. The
-v option can be used to determine the expiration date of the feature
and the expiration date of all the licenses as a group. The "License
expiration" is when the feature will become unusable due to one or more
licenses expiring and is derived from the contents of the entire li-
cense file. The "Actual expiration" is when the feature will become
unusable if there are no other expired licenses and is decoded from the
license string for that feature.
Note: It is invalid to mix expiring licenses with non-expiring licenses
with the exception of the maintenance and proxy licenses.
EXAMPLES
When the command is run the license info for the indicated Xsan feature
is reported. Note that if license status cannot be determined for a
feature it is treated as NOT licensed. Also note some features have an
associated capacity and some do not.
Some examples:
Feature dedup is properly licensed for 10 terabytes and has no expira-
tion:
% snlicense dedup
- The dedup license status is: Good
% snlicense -v dedup
- Found existing license: dedup
- License expiration: None
- Actual expiration: None
- Licensed capacity: 10T
- Current used capacity: 2T
- The dedup license status is: Good
Feature replication is properly licensed and has no expiration:
% snlicense replication
- The replication license status is: Good
% snlicense -v replication
- Found existing license: replication
- License expiration: None
- Actual expiration: None
- The replication license status is: Good
Feature failover is not properly licensed, no license string in the li-
cense file:
% snlicense failover
- The failover license status is: License Missing
% snlicense -v failover
- The failover license status is: License Missing
Feature dedup has a valid license but the capacity has been reached:
% snlicense dedup
- The dedup license status is: Over Capacity
% snlicense -v dedup
- Found existing license: dedup
- License expiration: None
- Actual expiration: None
- Licensed capacity: 10T
- Current used capacity: 11T
- The dedup license status is: Over Capacity
Feature dedup has a valid license but the capacity could not be deter-
mined:
% snlicense dedup
- The dedup license status is: Capacity Undetermined
% snlicense -v dedup
- Found existing license: dedup
- License expiration: None
- Actual expiration: None
- Licensed capacity: 10T
- Current used capacity: UNKNOWN
- The dedup license status is: Capacity Undetermined
Feature snfs_was has a valid temporary license that has not expired
yet:
% snlicense -v snfs_was
- Found existing license: snfs_was
- License expiration: Thu Nov 1 23:59:59 2012
- Actual expiration: Thu Nov 1 23:59:59 2012
- The snfs_was license status is: Good
Feature gateway has a valid license with no expiration:
% snlicense -v gateway
- Found existing license: gateway
- License expiration: None
- Actual expiration: None
- The gateway license status is: Good
Feature failover has a license but it has expired:
% snlicense failover
- The failover license status is: Expired
% snlicense -v failover
- Found existing license: failover
- License expiration: Thu Jan 1 23:59:59 2009
- Actual expiration: Thu Jan 1 23:59:59 2009
- The failover license status is: Expired
Feature server has a valid license that does not expire but there is a
license for feature failover that expires. This is an invalid combina-
tion of expiring and non-expiring licenses:
% snlicense server
- Having both permanent and temporary licenses is not allowed
(except for 'maintenance' and DLAN 'proxy' licenses).
% snlicense -v server
- Found existing license: server
- License expiration: Jan 1 23:59:59 2009
- Actual expiration: None
- Licensed capacity: 10 connections
- Current used capacity: NA
- Having both permanent and temporary licenses is not allowed
(except for 'maintenance' and DLAN 'proxy' licenses).
% snlicense failover
- Having both permanent and temporary licenses is not allowed
(except for 'maintenance' and DLAN 'proxy' licenses).
% snlicense -v failover
- Found existing license: failover
- License expiration: Jan 1 23:59:59 2009
- Actual expiration: Jan 1 23:59:59 2009
- Having both permanent and temporary licenses is not allowed
(except for 'maintenance' and DLAN 'proxy' licenses).
EXIT VALUES
snlicense will return one of the following upon exit.
0 - No error, feature licensed and usable
1 - Feature not licensed but not in use
2 - Current feature capacity undetermined but feature not in use
3 - Feature has no license string in the license file
4 - Feature has a license but the expiration date has been reached
5 - Feature has a license but the capacity has been reached
6 - Feature has a license but the current capacity could not be determined
7 - Feature license status could not be determined
8 - Invalid mixture of temporary and permanent licenses detected
Xsan File System October 2014 snlicense(8)
Mac OS X 10.12.3 - Generated Fri Feb 10 08:38:40 CST 2017