sys smtp-server
sys smtp-server(1) BIG-IP TMSH Manual sys smtp-server(1)
NAME
smtp-server - Configure the SMTP server connection.
MODULE
sys
SYNTAX
Create or modify an SMTP server access configuration using the syntax in the following sections.
CREATE / MODIFY
modify smtp-server [name]
create smtp-server [name]
options:
app-service [[string] | none]
[authentication-enabled | authentication-disabled]
encrypted-connection [none | tls | ssl]
local-host-name [string]
smtp-server-host-name [string]
smtp-server-port [integer]
from-address [string]
username [string]
password [string]
DISPLAY
list smtp-server
show running-config smtp-server
options:
all-properties
DESCRIPTION
You can use the smtp-server component to configure an SMTP server connection.
EXAMPLES
list smtp-server
Displays the SMTP configuration.
modify smtp-server smtp1 authentication-enabled encrypted-connection ssl local-host-name example.f5.com from-
address example@f5.com smtp-server-host-name mail.server.com username user password pass
Configures SMTP server connection with username=user and password=pass to be authenticated against the SMTP
server mail.server.com. SSL encryption will be used for all communication with the SMTP server. Email messages
will be sent out with the address example@f5.com in the "Reply-To" address.
OPTIONS
app-service
Specifies the name of the application service to which the object belongs. The default value is none.
Note: If the strict-updates option is enabled on the application service that owns the object, you cannot
modify or delete the object. Only the application service can modify or delete the object.
[authentication-enabled | authentication-disabled]
Enables or disables authentication against the configured SMTP server.
encrypted-connection
Specifies which type of encrypted connection the SMTP server requires in order to send mail. The default
value is none.
local-host-name
Specifies the host name used in SMTP headers in the format of a fully qualified domain name. This setting
does not refer to the BIG-IP system's Hostname.
smtp-server-host-name
Specifies the SMTP server host name in the format of a fully qualified domain name.
smtp-server-port
Specifies the SMTP port number. The default value is 25.
from-address
Specifies the email address that the email is being sent from. This is the "Reply-to" address that the
recipient sees.
username
Specifies the user name that the SMTP server requires when validating a user.
password
Specifies the password that the SMTP server requires when validating a user. This password is stored in
an encrypted form.
SEE ALSO
list, create, modify, show, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or
mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose
other than the purchaser's personal use, without the express written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2009-2012. All rights reserved.
BIG-IP 2012-05-22 sys smtp-server(1)